Skip to content

Missing API docs part 1 - SA #3531

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
Nov 22, 2019
Merged

Missing API docs part 1 - SA #3531

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
f74aa1d
missing API docs part 1
steveada Nov 19, 2019
3c32353
Merge branch 'master' of https://github.com/dotnet/dotnet-api-docs in…
steveada Nov 19, 2019
48161b5
escape characters
steveada Nov 19, 2019
2ed8cd4
review changes
steveada Nov 21, 2019
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
Prev Previous commit
review changes
  • Loading branch information
@steveada
steveada committed Nov 21, 2019
commit 2ed8cd42f1ff340b63fd78b18dc2b3b58735fd93
14 changes: 7 additions & 7 deletions xml/Microsoft.Build.Tasks/GenerateManifestBase.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,10 +289,10 @@
<Parameter Name="versionB" Type="System.String" Index="1" FrameworkAlternate="netframework-3.5" />
</Parameters>
<Docs>
<param name="versionA">A string containing the major and minor versions of the first framework to compare, and also optionally build and revision numbers, where each number is delimited with a period character ('.').</param>
<param name="versionB">A string containing the major and minor versions of the second framework to compare, and also optionally build and revision numbers, where each number is delimited with a period character ('.').</param>
<summary>When implemented in a derived class, compares two versions of the framework.</summary>
<returns>A number indicating the relationship between the two versions: 0 means they are the same, 1 means the first framework is later, and -1 means the second framework is later.</returns>
<param name="versionA">The first .NET Framework version to compare.</param>
<param name="versionB">The second .NET Framework version to compare.</param>
<summary>Compares two .NET Framework versions and determines which version comes before the other one.</summary>
<returns>An integer value that specifies the sort order position of a .NET Framework version instance relative to another version instance. A value of 0 means the two values are equal, a value of -1 indicates that <paramref name="versionA" /> precedes <paramref name="versionB" />, and a value of 1 indicates that <paramref name="versionA" /> comes after <paramref name="versionB" />.</returns>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
Expand All @@ -315,9 +315,9 @@
<Parameter Name="version" Type="System.String" Index="0" FrameworkAlternate="netframework-3.5" />
</Parameters>
<Docs>
<param name="version">A string containing the major and minor versions of a framework, and also optionally build and revision numbers, where each number is delimited with a period character ('.').</param>
<summary>Initializes a new instance of the <see cref="T:System.Version" /> class using the specified string.</summary>
<returns>A <see cref="T:System.Version" /> object representing the the framework version.</returns>
<param name="version">The .NET Framework version number to convert to a string.</param>
<summary>Converts the given .NET Framework version to a string.</summary>
<returns>A string that represents the .NET Framework version.</returns>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
Expand Down
2 changes: 1 addition & 1 deletion xml/Microsoft.CSharp.Activities/CSharpReference`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
</Attribute>
</Attributes>
<Docs>
<typeparam name="TResult">The type of the return value of the C# reference.</typeparam>
<typeparam name="TResult">The type of the C# reference.</typeparam>
<summary>Specifies information about a C# reference.</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down
8 changes: 4 additions & 4 deletions xml/Microsoft.CSharp/ErrorLevel.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>The overall process completed but some errors occurred.</summary>
<summary>An error diagnostic.</summary>
</Docs>
</Member>
<Member MemberName="FatalError">
Expand All @@ -62,7 +62,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>A critical or unrecoverable error.</summary>
<summary>A noncontinuable error diagnostic.</summary>
</Docs>
</Member>
<Member MemberName="None">
Expand All @@ -83,7 +83,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Completion with no errors or warnings.</summary>
<summary>An unknown severity.</summary>
</Docs>
</Member>
<Member MemberName="Warning">
Expand All @@ -104,7 +104,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Highlights an abnormal or unexpected event.</summary>
<summary>A warning or suggestive diagnostic.</summary>
</Docs>
</Member>
</Members>
Expand Down
22 changes: 11 additions & 11 deletions xml/Microsoft.IE/Manager+URL_CANONFLAGS.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>2097152</MemberValue>
<Docs>
<summary>Converts a Microsoft MS-DOS path to a canonicalized URL.</summary>
<summary>Convert to a URL if in a dospath format.</summary>
</Docs>
</Member>
<Member MemberName="URL_DONT_ESCAPE_EXTRA_INFO">
Expand All @@ -86,7 +86,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>33554432</MemberValue>
<Docs>
<summary>Do not escape characters after "#" or "?", and do not remove trailing white space after "?".</summary>
<summary>Used only in conjunction with URL_ESCAPE_SPACES_ONLY to prevent the conversion of characters in the query (the portion of the URL following the first # or ? character encountered in the string). This flag should not be used alone or combined with URL_ESCAPE_SEGMENT_ONLY.</summary>
</Docs>
</Member>
<Member MemberName="URL_DONT_SIMPLIFY">
Expand Down Expand Up @@ -128,7 +128,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>33554432</MemberValue>
<Docs>
<summary>Defined to be the same as URL_DONT_ESCAPE_EXTRA_INFO.</summary>
<summary>Used only in conjunction with URL_ESCAPE_SPACES_ONLY to prevent the conversion of characters in the query (the portion of the URL following the first # or ? character encountered in the string). This flag should not be used alone or combined with URL_ESCAPE_SEGMENT_ONLY.</summary>
</Docs>
</Member>
<Member MemberName="URL_ESCAPE_PERCENT">
Expand Down Expand Up @@ -170,7 +170,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>8192</MemberValue>
<Docs>
<summary>Escape only the URL segment, including any URL parameters as part of the URL segment.</summary>
<summary>Indication that the URL contains only the section following the server component but preceding the query. All unsafe characters in the string are converted. If a full URL is provided when this flag is set, all unsafe characters in the entire string are converted, including # and ? characters. Combine this flag with URL_ESCAPE_PERCENT to include that character in the conversion. This flag cannot be combined with URL_ESCAPE_SPACES_ONLY or URL_DONT_ESCAPE_EXTRA_INFO.</summary>
</Docs>
</Member>
<Member MemberName="URL_ESCAPE_SPACES_ONLY">
Expand Down Expand Up @@ -212,7 +212,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>536870912</MemberValue>
<Docs>
<summary>Replace unsafe characters with their escape sequences. Unsafe characters are those characters that may be altered during transport across the Internet, and include the (&lt;, &gt;, &quot;, #, {, }, |, , ^, [, ], and &apos;) characters. This flag applies to all URLs, including opaque URLs.</summary>
<summary>Replace unsafe characters with their escape sequences. Unsafe characters are those characters that may be altered during transport across the Internet, and include the &lt;, &gt;, &quot;, #, {, }, |, \, ^, [, ], and &apos; characters. This flag applies to all URLs, including opaque URLs.</summary>
</Docs>
</Member>
<Member MemberName="URL_FILE_USE_PATHURL">
Expand All @@ -233,7 +233,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>65536</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Use DOS path compatibility mode to create "file" Uniform Resource Identifiers (URIs).</summary>
</Docs>
</Member>
<Member MemberName="URL_INTERNAL_PATH">
Expand Down Expand Up @@ -296,7 +296,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>1073741824</MemberValue>
<Docs>
<summary>Combine URLs with client-defined pluggable protocols, according to the W3C specification. This flag does not apply to standard protocols such as ftp, http, gopher, and so on. If this flag is set, URLs are not simplified, so there is no need to also set URL_DONT_SIMPLIFY.</summary>
<summary>Combine URLs with client-defined pluggable protocols, according to the World Wide Web Consortium (W3C) specification. This flag does not apply to standard protocols such as ftp, http, gopher, and so on.</summary>
</Docs>
</Member>
<Member MemberName="URL_UNESCAPE">
Expand All @@ -317,7 +317,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>268435456</MemberValue>
<Docs>
<summary>Un-escape any escape sequences that the URLs contain, with two exceptions. The escape sequences for "?" and "#" are not un-escaped. If one of the URL_ESCAPE_XXX flags is also set, the two URLs are first un-escaped, then combined, then escaped.</summary>
<summary>Unescape any escape sequences that the URLs contain, with two exceptions. The escape sequences for "?" and "#" are not un-escaped. If one of the URL_ESCAPE flags is also set, the two URLs are first un-escaped, then combined, then escaped.</summary>
</Docs>
</Member>
<Member MemberName="URL_UNESCAPE_HIGH_ANSI_ONLY">
Expand All @@ -338,7 +338,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>4194304</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Unescape only high ANSI escape characters.</summary>
</Docs>
</Member>
<Member MemberName="URL_UNESCAPE_INPLACE">
Expand All @@ -359,7 +359,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>1048576</MemberValue>
<Docs>
<summary>Converts escape sequences back into ordinary characters and overwrites the original string.</summary>
<summary>Convert escape sequences back into ordinary characters and overwrites the original string.</summary>
</Docs>
</Member>
<Member MemberName="URL_WININET_COMPATIBILITY">
Expand All @@ -380,7 +380,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>-2147483648</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Merge all the parameters to create a full URL.</summary>
</Docs>
</Member>
</Members>
Expand Down
14 changes: 7 additions & 7 deletions xml/Microsoft.IE/Manager+URL_IS.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ This enumeration is used in calls to the unmanaged UrlIs function.
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>Attempt to determine a valid scheme for the URL.</summary>
<summary>The UrlIs function will attempt to determine a valid scheme for the URL.</summary>
</Docs>
</Member>
<Member MemberName="URLIS_DIRECTORY">
Expand All @@ -65,7 +65,7 @@ This enumeration is used in calls to the unmanaged UrlIs function.
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary>Does the URL string end with a directory?</summary>
<summary>The URL string ends with a directory name.</summary>
</Docs>
</Member>
<Member MemberName="URLIS_FILEURL">
Expand All @@ -86,7 +86,7 @@ This enumeration is used in calls to the unmanaged UrlIs function.
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>Is the URL a file URL?</summary>
<summary>The URL is a file URL, which takes the form file://host/path.</summary>
</Docs>
</Member>
<Member MemberName="URLIS_HASQUERY">
Expand All @@ -107,7 +107,7 @@ This enumeration is used in calls to the unmanaged UrlIs function.
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>Does the URL have an appended query string?</summary>
<summary>The URL has an appended query string.</summary>
</Docs>
</Member>
<Member MemberName="URLIS_NOHISTORY">
Expand All @@ -128,7 +128,7 @@ This enumeration is used in calls to the unmanaged UrlIs function.
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Is the URL a URL that is not typically tracked in navigation history?</summary>
<summary>The URL is a no-history URL, which is a URL that browsers typically do not include in their navigation history.</summary>
</Docs>
</Member>
<Member MemberName="URLIS_OPAQUE">
Expand All @@ -149,7 +149,7 @@ This enumeration is used in calls to the unmanaged UrlIs function.
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Does the URL use a scheme that is not followed by two slashes (//)?</summary>
<summary>The URL is opaque, which means that it has a scheme that is not followed by two forward slashes (//).</summary>
</Docs>
</Member>
<Member MemberName="URLIS_URL">
Expand All @@ -170,7 +170,7 @@ This enumeration is used in calls to the unmanaged UrlIs function.
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Is the URL valid?</summary>
<summary>The URL is valid.</summary>
</Docs>
</Member>
</Members>
Expand Down
12 changes: 6 additions & 6 deletions xml/Microsoft.IE/Manager+URL_PART.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>The host name.</summary>
<summary>The host name part of the URL.</summary>
</Docs>
</Member>
<Member MemberName="NONE">
Expand All @@ -58,7 +58,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>None of the parts of the URL.</summary>
<summary>No part of the URL.</summary>
</Docs>
</Member>
<Member MemberName="PASSWORD">
Expand All @@ -79,7 +79,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>The password.</summary>
<summary>The password part of the URL.</summary>
</Docs>
</Member>
<Member MemberName="PORT">
Expand All @@ -100,7 +100,7 @@
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary>The port number.</summary>
<summary>The port number part of the URL.</summary>
</Docs>
</Member>
<Member MemberName="QUERY">
Expand All @@ -121,7 +121,7 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>The query portion of the URL.</summary>
<summary>The query string part of the URL.</summary>
</Docs>
</Member>
<Member MemberName="SCHEME">
Expand Down Expand Up @@ -163,7 +163,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>The username.</summary>
<summary>The user name part of the URL.</summary>
</Docs>
</Member>
</Members>
Expand Down
2 changes: 1 addition & 1 deletion xml/Microsoft.JScript/IDebugConvert.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@
<Docs>
<param name="hr">The HRESULT error code.</param>
<param name="engine">A reference to the scripting engine.</param>
<summary>When implemented in a class, gets an error message that is created from the specified <see cref="P:System.Exception.HResult" /> and the <see cref="T:System.Globalization.CultureInfo" /> of the specified <see cref="T:Microsoft.JScript.Vsa.IJSVsaEngine" />.</summary>
<summary>When implemented in a class, gets an error message that is created from the specified <see cref="P:System.Exception.HResult" /> and the <see cref="T:System.Globalization.CultureInfo" /> of the specified <see cref="T:Microsoft.Vsa.IVsaEngine" />.</summary>
<returns>A localized string that contains information about the error.</returns>
<remarks>To be added.</remarks>
<forInternalUseOnly />
Expand Down
9 changes: 5 additions & 4 deletions xml/Microsoft.VisualBasic.Vsa/VsaGlobalItem.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Sets a value indicating whether the members of the global object should be made available to the script engine.</summary>
<value>Returns TRUE if public members of the global object are available to the script engine without qualification, as if they are part of the global namespace. Returns FALSE if a member of the global object must be qualified with the object's name.</value>
<summary>Gets or sets a value that indicates whether the members of the global object should be made available to the script engine.</summary>
<value>
<see langword="true" /> if public members of the global object are available to the script engine without qualification, as if they are part of the global namespace. <see langword="false" /> if a member of the global object must be qualified with the object's name.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -76,8 +77,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the type of the global item.</summary>
<value>The item type of the global item.</value>
<summary>Sets the type of the global item.</summary>
<value>The type of the global item.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down