diff options
author | Joel Martinez <joelmartinez@gmail.com> | 2014-05-12 22:51:54 +0400 |
---|---|---|
committer | Joel Martinez <joelmartinez@gmail.com> | 2014-05-12 22:52:53 +0400 |
commit | e9068ebf5b5237e95ba5924bd978c5d119f8290c (patch) | |
tree | c7cf85e8501bf9705a7ada9d1d5e06a2539f7064 /mcs/class/System.Configuration.Install/Documentation | |
parent | 891e93e1fe61851ef779d5b995caf2d0c3cda8ed (diff) |
[docs] documentation import for 'returns' elements.
Diffstat (limited to 'mcs/class/System.Configuration.Install/Documentation')
6 files changed, 36 insertions, 9 deletions
diff --git a/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/ComponentInstaller.xml b/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/ComponentInstaller.xml index 2c0e721e723..f6604c71c3d 100644 --- a/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/ComponentInstaller.xml +++ b/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/ComponentInstaller.xml @@ -70,7 +70,6 @@ <Parameter Name="otherInstaller" Type="System.Configuration.Install.ComponentInstaller" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Typically, <see cref="M:System.Configuration.Install.ComponentInstaller.IsEquivalentInstaller(System.Configuration.Install.ComponentInstaller)" /> returns true only if this installer and the installer specified by the <paramref name="otherInstaller" /> parameter install the same object. In such a case, calling the <see cref="M:System.Configuration.Install.Installer.Install(System.Collections.IDictionary)" /> or <see cref="M:System.Configuration.Install.Installer.Uninstall(System.Collections.IDictionary)" /> method on either installer results in the same system state.</para> @@ -79,6 +78,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines if the specified installer installs the same object as this installer.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if this installer and the installer specified by the <paramref name="otherInstaller" /> parameter install the same object; otherwise, false.</para> + </returns> <param name="otherInstaller"> <attribution license="cc4" from="Microsoft" modified="false" />The installer to compare. </param> </Docs> diff --git a/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/IManagedInstaller.xml b/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/IManagedInstaller.xml index fcbb778cc8e..933e5e5e799 100644 --- a/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/IManagedInstaller.xml +++ b/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/IManagedInstaller.xml @@ -34,12 +34,15 @@ <Parameter Name="hInstall" Type="System.Int32" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Executes a managed installation.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The return code for installutil.exe. A successful installation returns 0. Other values indicate failure.</para> + </returns> <param name="commandLine"> <attribution license="cc4" from="Microsoft" modified="false" />The command line that specifies the installation.</param> <param name="hInstall"> diff --git a/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/InstallContext.xml b/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/InstallContext.xml index b256858cc42..9d08c8b2e5d 100644 --- a/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/InstallContext.xml +++ b/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/InstallContext.xml @@ -79,7 +79,6 @@ <Parameter Name="paramName" Type="System.String" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>This method accesses the <see cref="P:System.Configuration.Install.InstallContext.Parameters" /> property, which contains a parsed version of the command-line parameters, to determine whether the specified parameter is true.</para> @@ -88,6 +87,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines whether the specified command-line parameter is true.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the specified parameter is set to "yes", "true", "1", or an empty string (""); otherwise, false.</para> + </returns> <param name="paramName"> <attribution license="cc4" from="Microsoft" modified="false" />The name of the command-line parameter to check. </param> </Docs> @@ -154,12 +157,15 @@ <Parameter Name="args" Type="System.String[]" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Parses the command-line parameters into a string dictionary.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A <see cref="T:System.Collections.Specialized.StringDictionary" /> containing the parsed command-line parameters.</para> + </returns> <param name="args"> <attribution license="cc4" from="Microsoft" modified="false" />An array containing the command-line parameters. </param> </Docs> diff --git a/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/InstallerCollection.xml b/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/InstallerCollection.xml index 35c7e4b6997..3e8faef8274 100644 --- a/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/InstallerCollection.xml +++ b/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/InstallerCollection.xml @@ -46,7 +46,6 @@ <Parameter Name="value" Type="System.Configuration.Install.Installer" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>The <see cref="P:System.Configuration.Install.Installer.Parent" /> property of the added <see cref="T:System.Configuration.Install.Installer" /> is set to specify the <see cref="T:System.Configuration.Install.Installer" /> containing this collection.</para> @@ -55,6 +54,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Adds the specified installer to this collection of installers.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The zero-based index of the added installer.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Configuration.Install.Installer" /> that represents the installer to add to the collection. </param> </Docs> @@ -125,12 +128,15 @@ <Parameter Name="value" Type="System.Configuration.Install.Installer" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines whether the specified installer is included in collection.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the specified installer is in this collection; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Configuration.Install.Installer" /> that represents the installer to look for. </param> </Docs> @@ -175,12 +181,15 @@ <Parameter Name="value" Type="System.Configuration.Install.Installer" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines the index of a specified installer in the collection.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The zero-based index of the installer in the collection.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Configuration.Install.Installer" /> to locate in the collection. </param> </Docs> diff --git a/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/ManagedInstallerClass.xml b/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/ManagedInstallerClass.xml index d0a5b27a18d..0fc29fff1cf 100644 --- a/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/ManagedInstallerClass.xml +++ b/mcs/class/System.Configuration.Install/Documentation/en/System.Configuration.Install/ManagedInstallerClass.xml @@ -84,7 +84,6 @@ <Parameter Name="hInstall" Type="System.Int32" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Configuration.Install.ManagedInstallerClass" /> instance is cast to an <see cref="T:System.Configuration.Install.IManagedInstaller" /> interface.</para> @@ -93,6 +92,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>For a description of this member, see <see cref="M:System.Configuration.Install.IManagedInstaller.ManagedInstall(System.String,System.Int32)" />.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The return code for installutil.exe. A successful installation returns 0. Other values indicate failure.</para> + </returns> <param name="argString"> <attribution license="cc4" from="Microsoft" modified="false" />The command line to install.</param> <param name="hInstall"> diff --git a/mcs/class/System.Configuration.Install/Documentation/en/System.Diagnostics/EventLogInstaller.xml b/mcs/class/System.Configuration.Install/Documentation/en/System.Diagnostics/EventLogInstaller.xml index aaedc028fd8..ed2aba908de 100644 --- a/mcs/class/System.Configuration.Install/Documentation/en/System.Diagnostics/EventLogInstaller.xml +++ b/mcs/class/System.Configuration.Install/Documentation/en/System.Diagnostics/EventLogInstaller.xml @@ -181,7 +181,6 @@ <Parameter Name="otherInstaller" Type="System.Configuration.Install.ComponentInstaller" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Typically, you do not call the methods of the <see cref="T:System.Diagnostics.EventLogInstaller" /> from within your code; they are generally called only by the Installer tool (Installutil.exe).</para> @@ -190,6 +189,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines whether an installer and another specified installer refer to the same source.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if this installer and the installer specified by the <paramref name="otherInstaller" /> parameter would install or uninstall the same source; otherwise, false.</para> + </returns> <param name="otherInstaller"> <attribution license="cc4" from="Microsoft" modified="false" />The installer to compare. </param> </Docs> |