Skip to content

Commit 904195d

Browse files
David Klinehpsin
authored andcommitted
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
1 parent 6725587 commit 904195d

File tree

7 files changed

+25
-5
lines changed

7 files changed

+25
-5
lines changed

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/AppDeployment.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,7 @@ public class PackageInfo
379379
[DataMember(Name = "PackageOrigin")]
380380
public int PackageOrigin { get; private set; }
381381

382-
// <summary>
382+
/// <summary>
383383
/// Helper method to determine if the app was sideloaded and therefore can be used with e.g. GetFolderContentsAsync
384384
/// </summary>
385385
/// <returns> True if the package is sideloaded. </returns>

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/IoTOnboarding.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public async Task<AllJoynSettingsInfo> GetAllJoynSettingsInfoAsync()
4949
/// </summary>
5050
/// <param name="softApStatus">SoftAp Status.</param>
5151
/// <param name="softApSsid">SoftAp Ssid.</param>
52-
/// /// <param name="SoftAp Password">SoftAp Password.</param>
52+
/// /// <param name="softApPassword">SoftAp Password.</param>
5353
/// <returns>Task tracking completion of the REST call.</returns>
5454
public async Task SetSoftApSettingsAsync(string softApStatus, string softApSsid, string softApPassword)
5555
{
@@ -64,7 +64,7 @@ await this.PostAsync(
6464
/// <param name="allJoynStatus">AllJoyn Status.</param>
6565
/// <param name="allJoynDescription">AllJoyn Description.</param>
6666
/// <param name=" allJoynManufacturer"> AllJoyn Manufacturer.</param>
67-
/// <param name=" allJoynNumber"> AllJoyn Number.</param>
67+
/// <param name=" allJoynModelNumber"> AllJoyn Number.</param>
6868
/// <returns>Task tracking completion of the REST call.</returns>
6969
public async Task SetAllJoynSettingsAsync(string allJoynStatus, string allJoynDescription, string allJoynManufacturer, string allJoynModelNumber)
7070
{

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/Limpet.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public async Task<TpmLogicalDeviceSettingsInfo> GetTpmLogicalDeviceSettingsInfoA
7474
/// </summary>
7575
/// <param name="logicalDeviceId">Logical Device Id.</param>
7676
/// <param name="azureUri">Azure Uri.</param>
77-
/// <param name="Azure Key">Azure Key.</param>
77+
/// <param name="azureKey">Azure Key.</param>
7878
/// <returns>Task tracking completion of the REST call.</returns>
7979
public async Task SetTpmLogicalDeviceSettingsInfoAsync(int logicalDeviceId, string azureUri, string azureKey)
8080
{

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.UniversalWindows/Core/AppDeployment.cs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,20 @@ public async Task<ApplicationInstallStatus> GetInstallStatusAsync()
112112
}
113113
#pragma warning restore 1998
114114

115+
/// <summary>
116+
/// Installs an application
117+
/// </summary>
118+
/// <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>
119+
/// <param name="packageFile">The application package file.</param>
120+
/// <param name="dependencyFiles">List containing the required dependency files.</param>
121+
/// <param name="certificateFile">Optional certificate file.</param>
122+
/// <param name="stateCheckIntervalMs">How frequently we should check the installation state.</param>
123+
/// <param name="timeoutInMinutes">Operation timeout.</param>
124+
/// <param name="uninstallPreviousVersion">Indicate whether or not the previous app version should be uninstalled prior to installing.</param>
125+
/// <remarks>InstallApplication sends ApplicationInstallStatus events to indicate the current progress in the installation process.
126+
/// Some applications may opt to not register for the AppInstallStatus event and await on InstallApplication.</remarks>
127+
/// <returns>Task for tracking completion of install initialization.</returns>
128+
115129
public async Task InstallApplicationAsync(
116130
string appName,
117131
StorageFile packageFile,

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.UniversalWindows/WindowsDevicePortalWrapper.UniversalWindows.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
<DefineConstants>DEBUG;TRACE;NETFX_CORE;WINDOWS_UWP</DefineConstants>
2929
<ErrorReport>prompt</ErrorReport>
3030
<WarningLevel>4</WarningLevel>
31+
<DocumentationFile>
32+
</DocumentationFile>
3133
</PropertyGroup>
3234
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
3335
<PlatformTarget>AnyCPU</PlatformTarget>
@@ -37,6 +39,7 @@
3739
<DefineConstants>TRACE;NETFX_CORE;WINDOWS_UWP</DefineConstants>
3840
<ErrorReport>prompt</ErrorReport>
3941
<WarningLevel>4</WarningLevel>
42+
<DocumentationFile>bin\Release\WindowsDevicePortalWrapper.UniversalWindows.XML</DocumentationFile>
4043
</PropertyGroup>
4144
<PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|x86'">
4245
<PlatformTarget>x86</PlatformTarget>

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper/DefaultDevicePortalConnection.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public DefaultDevicePortalConnection(
4444
}
4545

4646
/// <summary>
47-
/// Initializes a new instance of the <see cref="XboxDevicePortalConnection"/> class, using a SecureString to secure the password.
47+
/// Initializes a new instance of the <see cref="DefaultDevicePortalConnection"/> class, using a SecureString to secure the password.
4848
/// </summary>
4949
/// <param name="address">device identifier</param>
5050
/// <param name="userName">WDP username</param>

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
<DefineConstants>DEBUG;TRACE</DefineConstants>
2323
<ErrorReport>prompt</ErrorReport>
2424
<WarningLevel>4</WarningLevel>
25+
<DocumentationFile>
26+
</DocumentationFile>
2527
</PropertyGroup>
2628
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
2729
<DebugType>pdbonly</DebugType>
@@ -30,6 +32,7 @@
3032
<DefineConstants>TRACE</DefineConstants>
3133
<ErrorReport>prompt</ErrorReport>
3234
<WarningLevel>4</WarningLevel>
35+
<DocumentationFile>bin\Release\WindowsDevicePortalWrapper.xml</DocumentationFile>
3336
</PropertyGroup>
3437
<ItemGroup>
3538
<Reference Include="System" />

0 commit comments

Comments
 (0)