Skip to content

add missing descriptions #1457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 22, 2018
Merged

add missing descriptions #1457

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eaec71e
add missing descriptions
mairaw Dec 21, 2018
944a125
more content
mairaw Dec 21, 2018
898e6c7
Fix build warning
mairaw Dec 21, 2018
af50e38
Fix build error
mairaw Dec 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion xml/Microsoft.VisualBasic/Interaction.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1328,7 +1328,9 @@ drawObj.SaveAs("C:\Drawings\sample.drw")
<param name="PathName">Required. <see langword="String" />. Name of the program to execute, together with any required arguments and command-line switches. <paramref name="PathName" /> can also include the drive and the directory path or folder.

If you do not know the path to the program, you can use the <see cref="Overload:Microsoft.VisualBasic.FileIO.FileSystem.GetFiles" /> to locate it. For example, you can call <c>My.Computer.FileSystem.GetFiles("C:\", True, "testFile.txt")</c>, which returns the full path of every file named <c>testFile.txt</c> anywhere on drive C:\\.</param>
<param name="Pathname">To be added.</param>
<param name="Pathname">Required. <see langword="String" />. Name of the program to execute, together with any required arguments and command-line switches. <paramref name="PathName" /> can also include the drive and the directory path or folder.

If you do not know the path to the program, you can use the <see cref="Overload:Microsoft.VisualBasic.FileIO.FileSystem.GetFiles" /> to locate it. For example, you can call <c>My.Computer.FileSystem.GetFiles("C:\", True, "testFile.txt")</c>, which returns the full path of every file named <c>testFile.txt</c> anywhere on drive C:\\.</param>
<param name="Style">Optional. <see langword="AppWinStyle" />. A value chosen from the <see cref="T:Microsoft.VisualBasic.AppWinStyle" /> specifying the style of the window in which the program is to run. If <paramref name="Style" /> is omitted, <see langword="Shell" /> uses <see langword="AppWinStyle.MinimizedFocus" />, which starts the program minimized and with focus.</param>
<param name="Wait">Optional. <see langword="Boolean" />. A value indicating whether the <see langword="Shell" /> function should wait for completion of the program. If <paramref name="Wait" /> is omitted, <see langword="Shell" /> uses <see langword="False" />.</param>
<param name="Timeout">Optional. <see langword="Integer" />. The number of milliseconds to wait for completion if <paramref name="Wait" /> is <see langword="True" />. If <paramref name="Timeout" /> is omitted, <see langword="Shell" /> uses -1, which means there is no timeout and <see langword="Shell" /> does not return until the program finishes. Therefore, if you omit <paramref name="Timeout" /> or set it to -1, it is possible that <see langword="Shell" /> might never return control to your program.</param>
Expand Down
2 changes: 1 addition & 1 deletion xml/Microsoft.VisualC/MiscellaneousBitsAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
</Parameters>
<Docs>
<param name="miscellaneousBits">A bit mask containing information about a type.</param>
<param name="dwAttrs">To be added.</param>
<param name="dwAttrs">A bit mask containing information about a type.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.VisualC.MiscellaneousBitsAttribute" /> class using the specified bit mask.</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down
10 changes: 7 additions & 3 deletions xml/System.Collections.ObjectModel/ReadOnlyDictionary`2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -650,10 +650,14 @@
<Parameter Name="key" Type="TKey" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<summary>To be added.</summary>
<value>To be added.</value>
<param name="key">The key of the element to get or set.</param>
<summary>Gets the element that has the specified key.</summary>
<value>The element that has the specified key.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="key" /> is <see langword="null" />.</exception>
<exception cref="T:System.Collections.Generic.KeyNotFoundException">The property is retrieved and <paramref name="key" /> is not found.</exception>
<exception cref="T:System.NotSupportedException">The property is set.</exception>
</Docs>
</Member>
<Member MemberName="System.Collections.Generic.IDictionary&lt;TKey,TValue&gt;.Keys">
Expand Down
5 changes: 3 additions & 2 deletions xml/System.Diagnostics/StackTrace.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -549,8 +549,9 @@
<param name="e">The exception object from which to construct the stack trace.</param>
<param name="fNeedFileInfo">
<see langword="true" /> to capture the file name, line number, and column number; otherwise, <see langword="false" />.</param>
<param name="exception">To be added.</param>
<param name="needFileInfo">To be added.</param>
<param name="exception">The exception object from which to construct the stack trace.</param>
<param name="needFileInfo">
<see langword="true" /> to capture the file name, line number, and column number; otherwise, <see langword="false" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.StackTrace" /> class, using the provided exception object and optionally capturing source information.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down
19 changes: 9 additions & 10 deletions xml/System.Security.Cryptography/SHA1Managed.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,12 +192,11 @@ This method is called by the public <xref:System.Security.Cryptography.HashAlgor
<Member MemberName="HashCore">
<MemberSignature Language="C#" Value="protected override sealed void HashCore (byte[] array, int ibStart, int cbSize);" FrameworkAlternate="netcore-2.0;netcore-2.1" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void HashCore(unsigned int8[] array, int32 ibStart, int32 cbSize) cil managed" FrameworkAlternate="netcore-2.0;netcore-2.1" />
<MemberSignature Language="DocId" Value="M:System.Security.Cryptography.SHA1Managed.HashCore(System.Byte[],System.Int32,System.Int32)" FrameworkAlternate="netcore-2.0;netcore-2.1;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netstandard-2.0;xamarinandroid-7.1" />
<MemberSignature Language="DocId" Value="M:System.Security.Cryptography.SHA1Managed.HashCore(System.Byte[],System.Int32,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides NotOverridable Sub HashCore (array As Byte(), ibStart As Integer, cbSize As Integer)" FrameworkAlternate="netcore-2.0;netcore-2.1" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; override void HashCore(cli::array &lt;System::Byte&gt; ^ array, int ibStart, int cbSize);" FrameworkAlternate="netcore-2.0;netcore-2.1" />
<MemberSignature Language="C#" Value="protected override void HashCore (byte[] rgb, int ibStart, int cbSize);" FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netstandard-2.0;xamarinandroid-7.1" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void HashCore(unsigned int8[] rgb, int32 ibStart, int32 cbSize) cil managed" FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netstandard-2.0;xamarinandroid-7.1" />
<MemberSignature Language="DocId" Value="M:System.Security.Cryptography.SHA1Managed.HashCore(System.Byte[],System.Int32,System.Int32)" FrameworkAlternate="netframework-4.5" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub HashCore (rgb As Byte(), ibStart As Integer, cbSize As Integer)" FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netstandard-2.0;xamarinandroid-7.1" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; override void HashCore(cli::array &lt;System::Byte&gt; ^ rgb, int ibStart, int cbSize);" FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netstandard-2.0;xamarinandroid-7.1" />
<MemberType>Method</MemberType>
Expand All @@ -219,21 +218,21 @@ This method is called by the public <xref:System.Security.Cryptography.HashAlgor
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="array" Type="System.Byte[]" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netstandard-2.0;xamarinandroid-7.1" />
<Parameter Name="array" Type="System.Byte[]" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1" />
Copy link
Contributor Author

@mairaw mairaw Dec 21, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joelmartinez here's my attempt to fix the signature problem. I also think that the MemberSignature entries is missing an entry for the signature for xamarinios-10.8

Copy link
Contributor

@joelmartinez joelmartinez Dec 21, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cool … I'm working on this particular issue right now, actually. I will add SHA1Managed to my list of test cases so I make sure it turns out correctly.

<Parameter Name="data" Type="System.Byte[]" Index="0" FrameworkAlternate="xamarinios-10.8" />
<Parameter Name="rgb" Type="System.Byte[]" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netstandard-2.0;xamarinandroid-7.1" />
<Parameter Name="rgb" Type="System.Byte[]" Index="0" FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netstandard-2.0;xamarinandroid-7.1" />
<Parameter Name="start" Type="System.Int32" Index="1" FrameworkAlternate="xamarinios-10.8" />
<Parameter Name="ibStart" Type="System.Int32" Index="2" FrameworkAlternate="netcore-2.0;netcore-2.1;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netstandard-2.0;xamarinandroid-7.1" />
<Parameter Name="ibStart" Type="System.Int32" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netstandard-2.0;xamarinandroid-7.1" />
<Parameter Name="length" Type="System.Int32" Index="2" FrameworkAlternate="xamarinios-10.8" />
<Parameter Name="cbSize" Type="System.Int32" Index="3" />
<Parameter Name="cbSize" Type="System.Int32" Index="2" FrameworkAlternate="netcore-2.0;netcore-2.1;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netstandard-2.0;xamarinandroid-7.1" />
</Parameters>
<Docs>
<param name="array">To be added.</param>
<param name="data">To be added.</param>
<param name="array">The input data.</param>
<param name="data">The input data.</param>
<param name="rgb">The input data.</param>
<param name="start">To be added.</param>
<param name="start">The offset into the byte array from which to begin using data.</param>
<param name="ibStart">The offset into the byte array from which to begin using data.</param>
<param name="length">To be added.</param>
<param name="length">The number of bytes in the array to use as data.</param>
<param name="cbSize">The number of bytes in the array to use as data.</param>
<summary>Routes data written to the object into the <see cref="T:System.Security.Cryptography.SHA1Managed" /> hash algorithm for computing the hash.</summary>
<remarks>To be added.</remarks>
Expand Down
6 changes: 3 additions & 3 deletions xml/System.Security.Permissions/FileIOPermission.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@
<Docs>
<param name="access">A bitwise combination of the <see cref="T:System.Security.Permissions.FileIOPermissionAccess" /> enumeration values.</param>
<param name="control">A bitwise combination of the <see cref="T:System.Security.AccessControl.AccessControlActions" /> enumeration values.</param>
<param name="actions">To be added.</param>
<param name="actions">A bitwise combination of the <see cref="T:System.Security.AccessControl.AccessControlActions" /> enumeration values.</param>
<param name="path">The absolute path of the file or directory.</param>
<summary>Initializes a new instance of the <see cref="T:System.Security.Permissions.FileIOPermission" /> class with the specified access to the designated file or directory and the specified access rights to file control information.</summary>
<remarks>
Expand Down Expand Up @@ -350,7 +350,7 @@
<Docs>
<param name="access">A bitwise combination of the <see cref="T:System.Security.Permissions.FileIOPermissionAccess" /> enumeration values.</param>
<param name="control">A bitwise combination of the <see cref="T:System.Security.AccessControl.AccessControlActions" /> enumeration values.</param>
<param name="actions">To be added.</param>
<param name="actions">A bitwise combination of the <see cref="T:System.Security.AccessControl.AccessControlActions" /> enumeration values.</param>
<param name="pathList">An array containing the absolute paths of the files and directories.</param>
<summary>Initializes a new instance of the <see cref="T:System.Security.Permissions.FileIOPermission" /> class with the specified access to the designated files and directories and the specified access rights to file control information.</summary>
<remarks>
Expand Down Expand Up @@ -670,7 +670,7 @@
</Parameters>
<Docs>
<param name="o">The <see cref="T:System.Security.Permissions.FileIOPermission" /> object to compare with the current <see cref="T:System.Security.Permissions.FileIOPermission" />.</param>
<param name="obj">To be added.</param>
<param name="obj">The <see cref="T:System.Security.Permissions.FileIOPermission" /> object to compare with the current <see cref="T:System.Security.Permissions.FileIOPermission" />.</param>
<summary>Determines whether the specified <see cref="T:System.Security.Permissions.FileIOPermission" /> object is equal to the current <see cref="T:System.Security.Permissions.FileIOPermission" />.</summary>
<returns>
<see langword="true" /> if the specified <see cref="T:System.Security.Permissions.FileIOPermission" /> is equal to the current <see cref="T:System.Security.Permissions.FileIOPermission" /> object; otherwise, <see langword="false" />.</returns>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Permissions/PrincipalPermission.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@
</Parameters>
<Docs>
<param name="o">The <see cref="T:System.Security.Permissions.PrincipalPermission" /> object to compare with the current <see cref="T:System.Security.Permissions.PrincipalPermission" />.</param>
<param name="obj">To be added.</param>
<param name="obj">The <see cref="T:System.Security.Permissions.PrincipalPermission" /> object to compare with the current <see cref="T:System.Security.Permissions.PrincipalPermission" />.</param>
<summary>Determines whether the specified <see cref="T:System.Security.Permissions.PrincipalPermission" /> object is equal to the current <see cref="T:System.Security.Permissions.PrincipalPermission" />.</summary>
<returns>
<see langword="true" /> if the specified <see cref="T:System.Security.Permissions.PrincipalPermission" /> is equal to the current <see cref="T:System.Security.Permissions.PrincipalPermission" /> object; otherwise, <see langword="false" />.</returns>
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Security.Permissions/RegistryPermission.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@
<Docs>
<param name="access">One of the <see cref="T:System.Security.Permissions.RegistryPermissionAccess" /> values.</param>
<param name="control">One of the <see cref="T:System.Security.AccessControl.AccessControlActions" /> values.</param>
<param name="actions">To be added.</param>
<param name="actions">One of the <see cref="T:System.Security.AccessControl.AccessControlActions" /> values.</param>
<param name="pathList">A list of registry variables (separated by semicolons).</param>
<summary>Adds access for the specified registry variables to the existing state of the permission, specifying registry permission access and access control actions.</summary>
<remarks>
Expand Down Expand Up @@ -434,7 +434,7 @@
</Parameters>
<Docs>
<param name="elem">The XML encoding to use to reconstruct the permission.</param>
<param name="esd">To be added.</param>
<param name="esd">The XML encoding to use to reconstruct the permission.</param>
<summary>Reconstructs a permission with a specified state from an XML encoding.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="elem" /> parameter is <see langword="null" />.</exception>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Permissions/StrongNamePublicKeyBlob.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
</Parameters>
<Docs>
<param name="o">An object containing a public key blob.</param>
<param name="obj">To be added.</param>
<param name="obj">An object containing a public key blob.</param>
<summary>Gets or sets a value indicating whether the current public key blob is equal to the specified public key blob.</summary>
<returns>
<see langword="true" /> if the public key blob of the current object is equal to the public key blob of the <paramref name="o" /> parameter; otherwise, <see langword="false" />.</returns>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Policy/ApplicationTrust.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@
</Parameters>
<Docs>
<param name="identity">An <see cref="T:System.ApplicationIdentity" /> that uniquely identifies an application.</param>
<param name="applicationIdentity">To be added.</param>
<param name="applicationIdentity">An <see cref="T:System.ApplicationIdentity" /> that uniquely identifies an application.</param>
<summary>Initializes a new instance of the <see cref="T:System.Security.Policy.ApplicationTrust" /> class with an <see cref="T:System.ApplicationIdentity" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Policy/PolicyStatement.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@
</Parameters>
<Docs>
<param name="o">The <see cref="T:System.Security.Policy.PolicyStatement" /> object to compare with the current <see cref="T:System.Security.Policy.PolicyStatement" />.</param>
<param name="obj">To be added.</param>
<param name="obj">The <see cref="T:System.Security.Policy.PolicyStatement" /> object to compare with the current <see cref="T:System.Security.Policy.PolicyStatement" />.</param>
<summary>Determines whether the specified <see cref="T:System.Security.Policy.PolicyStatement" /> object is equal to the current <see cref="T:System.Security.Policy.PolicyStatement" />.</summary>
<returns>
<see langword="true" /> if the specified <see cref="T:System.Security.Policy.PolicyStatement" /> is equal to the current <see cref="T:System.Security.Policy.PolicyStatement" /> object; otherwise, <see langword="false" />.</returns>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security/NamedPermissionSet.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@
</Parameters>
<Docs>
<param name="o">The <see cref="T:System.Security.NamedPermissionSet" /> object to compare with the current <see cref="T:System.Security.NamedPermissionSet" />.</param>
<param name="obj">To be added.</param>
<param name="obj">The <see cref="T:System.Security.NamedPermissionSet" /> object to compare with the current <see cref="T:System.Security.NamedPermissionSet" />.</param>
<summary>Determines whether the specified <see cref="T:System.Security.NamedPermissionSet" /> object is equal to the current <see cref="T:System.Security.NamedPermissionSet" />.</summary>
<returns>
<see langword="true" /> if the specified <see cref="T:System.Security.NamedPermissionSet" /> is equal to the current <see cref="T:System.Security.NamedPermissionSet" /> object; otherwise, <see langword="false" />.</returns>
Expand Down