Updated documentation to reflect latest changes e33e882

Aptivi-Archives · Dec 10, 2023 · 3df7f51 · 3df7f51
1 parent b7f8cfd
commit 3df7f51
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 21 deletions.
diff --git a/api/ManagedWeatherMap.Core.Forecast.html b/api/ManagedWeatherMap.Core.Forecast.html
@@ -83,7 +83,8 @@
 
   <h1 id="ManagedWeatherMap_Core_Forecast" data-uid="ManagedWeatherMap.Core.Forecast" class="text-break">Class Forecast
 </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>The forecast tools</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
@@ -103,7 +104,7 @@ <h3 id="methods">Methods
     <a href="https://github.com/Aptivi/ManagedWeatherMap/new/main/apiSpec/new?filename=ManagedWeatherMap_Core_Forecast_GetWeatherInfo_System_Int64_System_String_ManagedWeatherMap_Core_UnitMeasurement_.md&amp;value=---%0Auid%3A%20ManagedWeatherMap.Core.Forecast.GetWeatherInfo(System.Int64%2CSystem.String%2CManagedWeatherMap.Core.UnitMeasurement)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L46">View Source</a>
+    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L50">View Source</a>
   </span>
   <a id="ManagedWeatherMap_Core_Forecast_GetWeatherInfo_" data-uid="ManagedWeatherMap.Core.Forecast.GetWeatherInfo*"></a>
   <h4 id="ManagedWeatherMap_Core_Forecast_GetWeatherInfo_System_Int64_System_String_ManagedWeatherMap_Core_UnitMeasurement_" data-uid="ManagedWeatherMap.Core.Forecast.GetWeatherInfo(System.Int64,System.String,ManagedWeatherMap.Core.UnitMeasurement)">GetWeatherInfo(long, string, UnitMeasurement)</h4>
@@ -139,7 +140,8 @@ <h5 class="parameters">Parameters</h5>
       <tr>
         <td><a class="xref" href="ManagedWeatherMap.Core.UnitMeasurement.html">UnitMeasurement</a></td>
         <td><span class="parametername">Unit</span></td>
-        <td></td>
+        <td><p>The preferred unit to use</p>
+</td>
       </tr>
     </tbody>
   </table>
@@ -164,7 +166,7 @@ <h5 class="returns">Returns</h5>
     <a href="https://github.com/Aptivi/ManagedWeatherMap/new/main/apiSpec/new?filename=ManagedWeatherMap_Core_Forecast_GetWeatherInfo_System_String_System_String_ManagedWeatherMap_Core_UnitMeasurement_.md&amp;value=---%0Auid%3A%20ManagedWeatherMap.Core.Forecast.GetWeatherInfo(System.String%2CSystem.String%2CManagedWeatherMap.Core.UnitMeasurement)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L58">View Source</a>
+    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L63">View Source</a>
   </span>
   <a id="ManagedWeatherMap_Core_Forecast_GetWeatherInfo_" data-uid="ManagedWeatherMap.Core.Forecast.GetWeatherInfo*"></a>
   <h4 id="ManagedWeatherMap_Core_Forecast_GetWeatherInfo_System_String_System_String_ManagedWeatherMap_Core_UnitMeasurement_" data-uid="ManagedWeatherMap.Core.Forecast.GetWeatherInfo(System.String,System.String,ManagedWeatherMap.Core.UnitMeasurement)">GetWeatherInfo(string, string, UnitMeasurement)</h4>
@@ -200,7 +202,8 @@ <h5 class="parameters">Parameters</h5>
       <tr>
         <td><a class="xref" href="ManagedWeatherMap.Core.UnitMeasurement.html">UnitMeasurement</a></td>
         <td><span class="parametername">Unit</span></td>
-        <td></td>
+        <td><p>The preferred unit to use</p>
+</td>
       </tr>
     </tbody>
   </table>
@@ -225,7 +228,7 @@ <h5 class="returns">Returns</h5>
     <a href="https://github.com/Aptivi/ManagedWeatherMap/new/main/apiSpec/new?filename=ManagedWeatherMap_Core_Forecast_GetWeatherInfoAsync_System_Int64_System_String_ManagedWeatherMap_Core_UnitMeasurement_.md&amp;value=---%0Auid%3A%20ManagedWeatherMap.Core.Forecast.GetWeatherInfoAsync(System.Int64%2CSystem.String%2CManagedWeatherMap.Core.UnitMeasurement)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L93">View Source</a>
+    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L100">View Source</a>
   </span>
   <a id="ManagedWeatherMap_Core_Forecast_GetWeatherInfoAsync_" data-uid="ManagedWeatherMap.Core.Forecast.GetWeatherInfoAsync*"></a>
   <h4 id="ManagedWeatherMap_Core_Forecast_GetWeatherInfoAsync_System_Int64_System_String_ManagedWeatherMap_Core_UnitMeasurement_" data-uid="ManagedWeatherMap.Core.Forecast.GetWeatherInfoAsync(System.Int64,System.String,ManagedWeatherMap.Core.UnitMeasurement)">GetWeatherInfoAsync(long, string, UnitMeasurement)</h4>
@@ -261,7 +264,8 @@ <h5 class="parameters">Parameters</h5>
       <tr>
         <td><a class="xref" href="ManagedWeatherMap.Core.UnitMeasurement.html">UnitMeasurement</a></td>
         <td><span class="parametername">Unit</span></td>
-        <td></td>
+        <td><p>The preferred unit to use</p>
+</td>
       </tr>
     </tbody>
   </table>
@@ -286,7 +290,7 @@ <h5 class="returns">Returns</h5>
     <a href="https://github.com/Aptivi/ManagedWeatherMap/new/main/apiSpec/new?filename=ManagedWeatherMap_Core_Forecast_GetWeatherInfoAsync_System_String_System_String_ManagedWeatherMap_Core_UnitMeasurement_.md&amp;value=---%0Auid%3A%20ManagedWeatherMap.Core.Forecast.GetWeatherInfoAsync(System.String%2CSystem.String%2CManagedWeatherMap.Core.UnitMeasurement)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L105">View Source</a>
+    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L113">View Source</a>
   </span>
   <a id="ManagedWeatherMap_Core_Forecast_GetWeatherInfoAsync_" data-uid="ManagedWeatherMap.Core.Forecast.GetWeatherInfoAsync*"></a>
   <h4 id="ManagedWeatherMap_Core_Forecast_GetWeatherInfoAsync_System_String_System_String_ManagedWeatherMap_Core_UnitMeasurement_" data-uid="ManagedWeatherMap.Core.Forecast.GetWeatherInfoAsync(System.String,System.String,ManagedWeatherMap.Core.UnitMeasurement)">GetWeatherInfoAsync(string, string, UnitMeasurement)</h4>
@@ -322,7 +326,8 @@ <h5 class="parameters">Parameters</h5>
       <tr>
         <td><a class="xref" href="ManagedWeatherMap.Core.UnitMeasurement.html">UnitMeasurement</a></td>
         <td><span class="parametername">Unit</span></td>
-        <td></td>
+        <td><p>The preferred unit to use</p>
+</td>
       </tr>
     </tbody>
   </table>
@@ -347,7 +352,7 @@ <h5 class="returns">Returns</h5>
     <a href="https://github.com/Aptivi/ManagedWeatherMap/new/main/apiSpec/new?filename=ManagedWeatherMap_Core_Forecast_ListAllCities.md&amp;value=---%0Auid%3A%20ManagedWeatherMap.Core.Forecast.ListAllCities%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L156">View Source</a>
+    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L165">View Source</a>
   </span>
   <a id="ManagedWeatherMap_Core_Forecast_ListAllCities_" data-uid="ManagedWeatherMap.Core.Forecast.ListAllCities*"></a>
   <h4 id="ManagedWeatherMap_Core_Forecast_ListAllCities" data-uid="ManagedWeatherMap.Core.Forecast.ListAllCities">ListAllCities()</h4>
@@ -378,7 +383,7 @@ <h5 class="returns">Returns</h5>
     <a href="https://github.com/Aptivi/ManagedWeatherMap/new/main/apiSpec/new?filename=ManagedWeatherMap_Core_Forecast_ListAllCitiesAsync.md&amp;value=---%0Auid%3A%20ManagedWeatherMap.Core.Forecast.ListAllCitiesAsync%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L170">View Source</a>
+    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L179">View Source</a>
   </span>
   <a id="ManagedWeatherMap_Core_Forecast_ListAllCitiesAsync_" data-uid="ManagedWeatherMap.Core.Forecast.ListAllCitiesAsync*"></a>
   <h4 id="ManagedWeatherMap_Core_Forecast_ListAllCitiesAsync" data-uid="ManagedWeatherMap.Core.Forecast.ListAllCitiesAsync">ListAllCitiesAsync()</h4>
@@ -416,7 +421,7 @@ <h5 class="returns">Returns</h5>
                     <a href="https://github.com/Aptivi/ManagedWeatherMap/new/main/apiSpec/new?filename=ManagedWeatherMap_Core_Forecast.md&amp;value=---%0Auid%3A%20ManagedWeatherMap.Core.Forecast%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
                   </li>
                   <li>
-                    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L36" class="contribution-link">View Source</a>
+                    <a href="https://github.com/Aptivi/ManagedWeatherMap/blob/main/ManagedWeatherMap/Forecast.cs/#L39" class="contribution-link">View Source</a>
                   </li>
                 </ul>
               </div>

diff --git a/api/ManagedWeatherMap.Core.html b/api/ManagedWeatherMap.Core.html
@@ -88,7 +88,8 @@ <h3 id="classes">
 Classes
 </h3>
       <h4><a class="xref" href="ManagedWeatherMap.Core.Forecast.html">Forecast</a></h4>
-      <section></section>
+      <section><p>The forecast tools</p>
+</section>
       <h4><a class="xref" href="ManagedWeatherMap.Core.ForecastInfo.html">ForecastInfo</a></h4>
       <section><p>Forecast information</p>
 </section>

diff --git a/index.json b/index.json
@@ -2,7 +2,7 @@
   "api/ManagedWeatherMap.Core.Forecast.html": {
     "href": "api/ManagedWeatherMap.Core.Forecast.html",
     "title": "Class Forecast | ManagedWeatherMap API - Aptivi",
-    "keywords": "Class Forecast Inheritance object Forecast Namespace: ManagedWeatherMap.Core Assembly: ManagedWeatherMap.dll Syntax public static class Forecast Methods | Edit this page View Source GetWeatherInfo(long, string, UnitMeasurement) Gets current weather info from OpenWeatherMap Declaration public static ForecastInfo GetWeatherInfo(long CityID, string APIKey, UnitMeasurement Unit = UnitMeasurement.Metric) Parameters Type Name Description long CityID City ID string APIKey API key UnitMeasurement Unit Returns Type Description ForecastInfo A class containing properties of weather information | Edit this page View Source GetWeatherInfo(string, string, UnitMeasurement) Gets current weather info from OpenWeatherMap Declaration public static ForecastInfo GetWeatherInfo(string CityName, string APIKey, UnitMeasurement Unit = UnitMeasurement.Metric) Parameters Type Name Description string CityName City name string APIKey API Key UnitMeasurement Unit Returns Type Description ForecastInfo A class containing properties of weather information | Edit this page View Source GetWeatherInfoAsync(long, string, UnitMeasurement) Gets current weather info from OpenWeatherMap Declaration public static Task<ForecastInfo> GetWeatherInfoAsync(long CityID, string APIKey, UnitMeasurement Unit = UnitMeasurement.Metric) Parameters Type Name Description long CityID City ID string APIKey API key UnitMeasurement Unit Returns Type Description Task<ForecastInfo> A class containing properties of weather information | Edit this page View Source GetWeatherInfoAsync(string, string, UnitMeasurement) Gets current weather info from OpenWeatherMap Declaration public static Task<ForecastInfo> GetWeatherInfoAsync(string CityName, string APIKey, UnitMeasurement Unit = UnitMeasurement.Metric) Parameters Type Name Description string CityName City name string APIKey API Key UnitMeasurement Unit Returns Type Description Task<ForecastInfo> A class containing properties of weather information | Edit this page View Source ListAllCities() Lists all the available cities Declaration public static Dictionary<long, string> ListAllCities() Returns Type Description Dictionary<long, string> | Edit this page View Source ListAllCitiesAsync() Lists all the available cities Declaration public static Task<Dictionary<long, string>> ListAllCitiesAsync() Returns Type Description Task<Dictionary<long, string>>"
+    "keywords": "Class Forecast The forecast tools Inheritance object Forecast Namespace: ManagedWeatherMap.Core Assembly: ManagedWeatherMap.dll Syntax public static class Forecast Methods | Edit this page View Source GetWeatherInfo(long, string, UnitMeasurement) Gets current weather info from OpenWeatherMap Declaration public static ForecastInfo GetWeatherInfo(long CityID, string APIKey, UnitMeasurement Unit = UnitMeasurement.Metric) Parameters Type Name Description long CityID City ID string APIKey API key UnitMeasurement Unit The preferred unit to use Returns Type Description ForecastInfo A class containing properties of weather information | Edit this page View Source GetWeatherInfo(string, string, UnitMeasurement) Gets current weather info from OpenWeatherMap Declaration public static ForecastInfo GetWeatherInfo(string CityName, string APIKey, UnitMeasurement Unit = UnitMeasurement.Metric) Parameters Type Name Description string CityName City name string APIKey API Key UnitMeasurement Unit The preferred unit to use Returns Type Description ForecastInfo A class containing properties of weather information | Edit this page View Source GetWeatherInfoAsync(long, string, UnitMeasurement) Gets current weather info from OpenWeatherMap Declaration public static Task<ForecastInfo> GetWeatherInfoAsync(long CityID, string APIKey, UnitMeasurement Unit = UnitMeasurement.Metric) Parameters Type Name Description long CityID City ID string APIKey API key UnitMeasurement Unit The preferred unit to use Returns Type Description Task<ForecastInfo> A class containing properties of weather information | Edit this page View Source GetWeatherInfoAsync(string, string, UnitMeasurement) Gets current weather info from OpenWeatherMap Declaration public static Task<ForecastInfo> GetWeatherInfoAsync(string CityName, string APIKey, UnitMeasurement Unit = UnitMeasurement.Metric) Parameters Type Name Description string CityName City name string APIKey API Key UnitMeasurement Unit The preferred unit to use Returns Type Description Task<ForecastInfo> A class containing properties of weather information | Edit this page View Source ListAllCities() Lists all the available cities Declaration public static Dictionary<long, string> ListAllCities() Returns Type Description Dictionary<long, string> | Edit this page View Source ListAllCitiesAsync() Lists all the available cities Declaration public static Task<Dictionary<long, string>> ListAllCitiesAsync() Returns Type Description Task<Dictionary<long, string>>"
   },
   "api/ManagedWeatherMap.Core.ForecastInfo.html": {
     "href": "api/ManagedWeatherMap.Core.ForecastInfo.html",
@@ -22,7 +22,7 @@
   "api/ManagedWeatherMap.Core.html": {
     "href": "api/ManagedWeatherMap.Core.html",
     "title": "Namespace ManagedWeatherMap.Core | ManagedWeatherMap API - Aptivi",
-    "keywords": "Namespace ManagedWeatherMap.Core Classes Forecast ForecastInfo Forecast information Enums UnitMeasurement Unit measurement WeatherCondition Weather condition"
+    "keywords": "Namespace ManagedWeatherMap.Core Classes Forecast The forecast tools ForecastInfo Forecast information Enums UnitMeasurement Unit measurement WeatherCondition Weather condition"
   },
   "index.html": {
     "href": "index.html",

diff --git a/sitemap.xml b/sitemap.xml
@@ -2,37 +2,37 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
   <url>
     <loc>https://aptivi.github.io/ManagedWeatherMap/api/ManagedWeatherMap.Core.Forecast.html</loc>
-    <lastmod>2023-12-10T10:55:06+00:00</lastmod>
+    <lastmod>2023-12-10T10:57:05+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://aptivi.github.io/ManagedWeatherMap/api/ManagedWeatherMap.Core.ForecastInfo.html</loc>
-    <lastmod>2023-12-10T10:55:06+00:00</lastmod>
+    <lastmod>2023-12-10T10:57:05+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://aptivi.github.io/ManagedWeatherMap/api/ManagedWeatherMap.Core.UnitMeasurement.html</loc>
-    <lastmod>2023-12-10T10:55:06+00:00</lastmod>
+    <lastmod>2023-12-10T10:57:05+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://aptivi.github.io/ManagedWeatherMap/api/ManagedWeatherMap.Core.WeatherCondition.html</loc>
-    <lastmod>2023-12-10T10:55:06+00:00</lastmod>
+    <lastmod>2023-12-10T10:57:05+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://aptivi.github.io/ManagedWeatherMap/api/ManagedWeatherMap.Core.html</loc>
-    <lastmod>2023-12-10T10:55:06+00:00</lastmod>
+    <lastmod>2023-12-10T10:57:05+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>
   <url>
     <loc>https://aptivi.github.io/ManagedWeatherMap/index.html</loc>
-    <lastmod>2023-12-10T10:55:06+00:00</lastmod>
+    <lastmod>2023-12-10T10:57:05+00:00</lastmod>
     <changefreq>daily</changefreq>
     <priority>0.5</priority>
   </url>