Commit 67fd4169 authored by David Kline's avatar David Kline Committed by GitHub
Browse files

Merge pull request #234 from hpsin/master 

Minor doc fixes
parents 168bf98d 2ec34c9f

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/AppDeployment.cs

+1 −1
Original line number Diff line number Diff line
@@ -379,7 +379,7 @@ namespace Microsoft.Tools.WindowsDevicePortal 
            [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>

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/IoTOnboarding.cs

+2 −2
Original line number Diff line number Diff line
@@ -49,7 +49,7 @@ namespace Microsoft.Tools.WindowsDevicePortal 
        /// </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 @@ namespace Microsoft.Tools.WindowsDevicePortal 
        /// <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)

        {

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/Limpet.cs

+1 −1
Original line number Diff line number Diff line
@@ -74,7 +74,7 @@ namespace Microsoft.Tools.WindowsDevicePortal 
        /// </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)

        {

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.UniversalWindows/Core/AppDeployment.cs

+13 −0
Original line number Diff line number Diff line
@@ -112,6 +112,19 @@ namespace Microsoft.Tools.WindowsDevicePortal 
        }

#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,

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper/DefaultDevicePortalConnection.cs

+1 −1
Original line number Diff line number Diff line
@@ -44,7 +44,7 @@ namespace Microsoft.Tools.WindowsDevicePortal 
        }



        /// <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>