generate xml documentation for 0.9.4(#233)

* Update content for WER * Update docs for XML. * Update Copyright to 2017 :) * fixes for #226, 227 and 228 * enable xml documentation generation (#232) * enable xml documentation generation * only generate xml documentation in release builds * Update docs * Filenames to StorageFiles
microsoft · Mar 21, 2017 · 904195d · 904195d
1 parent 6725587
commit 904195d
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 5 deletions.
diff --git a/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/AppDeployment.cs b/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/AppDeployment.cs
@@ -379,7 +379,7 @@ public class PackageInfo
             [DataMember(Name = "PackageOrigin")]
             public int PackageOrigin { get; private set; }
 
-            // <summary>
+            /// <summary>
             /// Helper method to determine if the app was sideloaded and therefore can be used with e.g. GetFolderContentsAsync
             /// </summary>
             /// <returns> True if the package is sideloaded. </returns>

diff --git a/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/IoTOnboarding.cs b/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/IoTOnboarding.cs
@@ -49,7 +49,7 @@ public async Task<AllJoynSettingsInfo> GetAllJoynSettingsInfoAsync()
         /// </summary>
         /// <param name="softApStatus">SoftAp Status.</param>
         /// <param name="softApSsid">SoftAp Ssid.</param>
-        /// /// <param name="SoftAp Password">SoftAp Password.</param>
+        /// /// <param name="softApPassword">SoftAp Password.</param>
         /// <returns>Task tracking completion of the REST call.</returns>
         public async Task SetSoftApSettingsAsync(string softApStatus, string softApSsid, string softApPassword)
         {
@@ -64,7 +64,7 @@ await this.PostAsync(
         /// <param name="allJoynStatus">AllJoyn Status.</param>
         /// <param name="allJoynDescription">AllJoyn Description.</param>
         /// <param name=" allJoynManufacturer"> AllJoyn Manufacturer.</param>
-        /// <param name=" allJoynNumber"> AllJoyn Number.</param>
+        /// <param name=" allJoynModelNumber"> AllJoyn Number.</param>
         /// <returns>Task tracking completion of the REST call.</returns>
         public async Task SetAllJoynSettingsAsync(string allJoynStatus, string allJoynDescription, string allJoynManufacturer, string allJoynModelNumber)
         {

diff --git a/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/Limpet.cs b/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/Limpet.cs
@@ -74,7 +74,7 @@ public async Task<TpmLogicalDeviceSettingsInfo> GetTpmLogicalDeviceSettingsInfoA
         /// </summary>
         /// <param name="logicalDeviceId">Logical Device Id.</param>
         /// <param name="azureUri">Azure Uri.</param>
-        /// <param name="Azure Key">Azure Key.</param>
+        /// <param name="azureKey">Azure Key.</param>
         /// <returns>Task tracking completion of the REST call.</returns>
         public async Task SetTpmLogicalDeviceSettingsInfoAsync(int logicalDeviceId, string azureUri, string azureKey)
         {

diff --git a/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.UniversalWindows/Core/AppDeployment.cs b/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.UniversalWindows/Core/AppDeployment.cs
@@ -112,6 +112,20 @@ public async Task<ApplicationInstallStatus> GetInstallStatusAsync()
         }
 #pragma warning restore 1998
 
+        /// <summary>
+        /// Installs an application
+        /// </summary>
+        /// <param name="appName">Friendly name (ex: Hello World) of the application. If this parameter is not provided, the name of the package is assumed to be the app name.</param>
+        /// <param name="packageFile">The application package file.</param>
+        /// <param name="dependencyFiles">List containing the required dependency files.</param>
+        /// <param name="certificateFile">Optional certificate file.</param>
+        /// <param name="stateCheckIntervalMs">How frequently we should check the installation state.</param>
+        /// <param name="timeoutInMinutes">Operation timeout.</param>
+        /// <param name="uninstallPreviousVersion">Indicate whether or not the previous app version should be uninstalled prior to installing.</param>
+        /// <remarks>InstallApplication sends ApplicationInstallStatus events to indicate the current progress in the installation process.
+        /// Some applications may opt to not register for the AppInstallStatus event and await on InstallApplication.</remarks>
+        /// <returns>Task for tracking completion of install initialization.</returns>
+
         public async Task InstallApplicationAsync(
             string appName,
             StorageFile packageFile, 

diff --git a/...wsDevicePortalWrapper.UniversalWindows/WindowsDevicePortalWrapper.UniversalWindows.csproj b/...wsDevicePortalWrapper.UniversalWindows/WindowsDevicePortalWrapper.UniversalWindows.csproj
@@ -28,6 +28,8 @@
     <DefineConstants>DEBUG;TRACE;NETFX_CORE;WINDOWS_UWP</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>
+    </DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <PlatformTarget>AnyCPU</PlatformTarget>
@@ -37,6 +39,7 @@
     <DefineConstants>TRACE;NETFX_CORE;WINDOWS_UWP</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Release\WindowsDevicePortalWrapper.UniversalWindows.XML</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|x86'">
     <PlatformTarget>x86</PlatformTarget>

diff --git a/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper/DefaultDevicePortalConnection.cs b/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper/DefaultDevicePortalConnection.cs
@@ -44,7 +44,7 @@ public DefaultDevicePortalConnection(
         }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="XboxDevicePortalConnection"/> class, using a SecureString to secure the password.
+        /// Initializes a new instance of the <see cref="DefaultDevicePortalConnection"/> class, using a SecureString to secure the password.
         /// </summary>
         /// <param name="address">device identifier</param>
         /// <param name="userName">WDP username</param>

diff --git a/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.csproj b/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.csproj
@@ -22,6 +22,8 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>
+    </DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -30,6 +32,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+  <DocumentationFile>bin\Release\WindowsDevicePortalWrapper.xml</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="System" />