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
Next Next commit
missing API docs part 1
  • Loading branch information
@steveada
steveada committed Nov 19, 2019
commit f74aa1d7a788b48ffe90cb30adc8ebc765c4ee3c
16 changes: 9 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,11 +289,12 @@
<Parameter Name="versionB" Type="System.String" Index="1" FrameworkAlternate="netframework-3.5" />
</Parameters>
<Docs>
<param name="versionA">To be added.</param>
<param name="versionB">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<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>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="ConvertFrameworkVersionToString">
Expand All @@ -314,10 +315,11 @@
<Parameter Name="version" Type="System.String" Index="0" FrameworkAlternate="netframework-3.5" />
</Parameters>
<Docs>
<param name="version">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<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>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="Description">
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">To be added.</typeparam>
<typeparam name="TResult">The type of the return value of the C# reference.</typeparam>
Copy link
Contributor

@mairaw mairaw Nov 20, 2019

Choose a reason for hiding this comment

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

@BillWagner do you think we could just say this?

Suggested change
<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>To be added.</summary>
<summary>The overall process completed but some errors occurred.</summary>
</Docs>
</Member>
<Member MemberName="FatalError">
Expand All @@ -62,7 +62,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A critical or unrecoverable error.</summary>
</Docs>
</Member>
<Member MemberName="None">
Expand All @@ -83,7 +83,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Completion with no errors or warnings.</summary>
</Docs>
</Member>
<Member MemberName="Warning">
Expand All @@ -104,7 +104,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Highlights an abnormal or unexpected event.</summary>
</Docs>
</Member>
</Members>
Expand Down
28 changes: 14 additions & 14 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 @@ -44,7 +44,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>33554432</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Defined to be the same as URL_DONT_ESCAPE_EXTRA_INFO.</summary>
</Docs>
</Member>
<Member MemberName="URL_CONVERT_IF_DOSPATH">
Expand All @@ -65,7 +65,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>2097152</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Converts a Microsoft MS-DOS path to a canonicalized URL.</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>To be added.</summary>
<summary>Do not escape characters after "#" or "?", and do not remove trailing white space after "?".</summary>
</Docs>
</Member>
<Member MemberName="URL_DONT_SIMPLIFY">
Expand All @@ -107,7 +107,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>134217728</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Treat "/./" and "/../" in a URL string as literal characters, not as shorthand for navigation.</summary>
</Docs>
</Member>
<Member MemberName="URL_DONT_UNESCAPE_EXTRA_INFO">
Expand All @@ -128,7 +128,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>33554432</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Defined to be the same as URL_DONT_ESCAPE_EXTRA_INFO.</summary>
</Docs>
</Member>
<Member MemberName="URL_ESCAPE_PERCENT">
Expand All @@ -149,7 +149,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>4096</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Convert any occurrence of "%" to its escape sequence.</summary>
</Docs>
</Member>
<Member MemberName="URL_ESCAPE_SEGMENT_ONLY">
Expand All @@ -170,7 +170,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>8192</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Escape only the URL segment, including any URL parameters as part of the URL segment.</summary>
</Docs>
</Member>
<Member MemberName="URL_ESCAPE_SPACES_ONLY">
Expand All @@ -191,7 +191,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>67108864</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Replace only spaces with escape sequences. This flag takes precedence over URL_ESCAPE_UNSAFE, but does not apply to opaque URLs.</summary>
</Docs>
</Member>
<Member MemberName="URL_ESCAPE_UNSAFE">
Expand All @@ -212,7 +212,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>536870912</MemberValue>
<Docs>
<summary>To be added.</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 (<, >, ", #, {, }, |, , ^, [, ], and ') characters. This flag applies to all URLs, including opaque URLs.</summary>
</Docs>
</Member>
<Member MemberName="URL_FILE_USE_PATHURL">
Expand Down Expand Up @@ -254,7 +254,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>8388608</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Convert any occurrence of "#" to its escape sequence.</summary>
</Docs>
</Member>
<Member MemberName="URL_NO_META">
Expand All @@ -275,7 +275,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>134217728</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Defined to be the same as URL_DONT_SIMPLIFY.</summary>
</Docs>
</Member>
<Member MemberName="URL_PLUGGABLE_PROTOCOL">
Expand All @@ -296,7 +296,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>1073741824</MemberValue>
<Docs>
<summary>To be added.</summary>
<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>
</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>To be added.</summary>
<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>
</Docs>
</Member>
<Member MemberName="URL_UNESCAPE_HIGH_ANSI_ONLY">
Expand Down Expand Up @@ -359,7 +359,7 @@ This enumeration is used in calls to the unmanaged Windows function UrlCanonical
</ReturnValue>
<MemberValue>1048576</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Converts escape sequences back into ordinary characters and overwrites the original string.</summary>
</Docs>
</Member>
<Member MemberName="URL_WININET_COMPATIBILITY">
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>To be added.</summary>
<summary>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>To be added.</summary>
<summary>Does the URL string end with a directory?</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>To be added.</summary>
<summary>Is the URL a file URL?</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>To be added.</summary>
<summary>Does the URL have 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>To be added.</summary>
<summary>Is the URL a URL that is not typically tracked in 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>To be added.</summary>
<summary>Does the URL use a scheme that is not followed by two 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>To be added.</summary>
<summary>Is the URL valid?</summary>
</Docs>
</Member>
</Members>
Expand Down
14 changes: 7 additions & 7 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>To be added.</summary>
<summary>The host name.</summary>
</Docs>
</Member>
<Member MemberName="NONE">
Expand All @@ -58,7 +58,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>None of the parts of the URL.</summary>
</Docs>
</Member>
<Member MemberName="PASSWORD">
Expand All @@ -79,7 +79,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The password.</summary>
</Docs>
</Member>
<Member MemberName="PORT">
Expand All @@ -100,7 +100,7 @@
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The port number.</summary>
</Docs>
</Member>
<Member MemberName="QUERY">
Expand All @@ -121,7 +121,7 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The query portion of the URL.</summary>
</Docs>
</Member>
<Member MemberName="SCHEME">
Expand All @@ -142,7 +142,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The URL scheme.</summary>
</Docs>
</Member>
<Member MemberName="USERNAME">
Expand All @@ -163,7 +163,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The username.</summary>
</Docs>
</Member>
</Members>
Expand Down
14 changes: 7 additions & 7 deletions xml/Microsoft.IE/SecureFactory+WININET_CACHE_ENTRY.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
</ReturnValue>
<MemberValue>1048576</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Cookie cache entry.</summary>
</Docs>
</Member>
<Member MemberName="NORMAL_CACHE_ENTRY">
Expand All @@ -58,7 +58,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Normal cache entry; can be deleted to recover space for new entries.</summary>
</Docs>
</Member>
<Member MemberName="SPARSE_CACHE_ENTRY">
Expand All @@ -79,7 +79,7 @@
</ReturnValue>
<MemberValue>65536</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Partial response cache entry.</summary>
</Docs>
</Member>
<Member MemberName="STICKY_CACHE_ENTRY">
Expand All @@ -100,7 +100,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Sticky cache entry; exempt from scavenging.</summary>
</Docs>
</Member>
<Member MemberName="TRACK_OFFLINE_CACHE_ENTRY">
Expand All @@ -121,7 +121,7 @@
</ReturnValue>
<MemberValue>16</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Not currently implemented.</summary>
</Docs>
</Member>
<Member MemberName="TRACK_ONLINE_CACHE_ENTRY">
Expand All @@ -142,7 +142,7 @@
</ReturnValue>
<MemberValue>32</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Not currently implemented.</summary>
</Docs>
</Member>
<Member MemberName="URLHISTORY_CACHE_ENTRY">
Expand All @@ -163,7 +163,7 @@
</ReturnValue>
<MemberValue>2097152</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Visited link cache entry.</summary>
</Docs>
</Member>
</Members>
Expand Down
Loading