From 3efa2da7d8b3ab3721b50da393328ffe4bced0ed Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Wed, 18 Dec 2024 17:13:28 -0800 Subject: [PATCH] fix inheritdoc warnings --- .../OrderedDictionary`2+ValueCollection.xml | 2 +- .../TwoColumnHelpRow.xml | 2 +- xml/System.CommandLine.Parsing/Token.xml | 2 +- xml/System.CommandLine/ArgumentArity.xml | 2 +- xml/System.CommandLine/Option.xml | 4 +- xml/System.CommandLine/Option`1.xml | 18 +- .../HttpHeadersNonValidated.xml | 4 +- .../CoseHeaderMap.xml | 8 +- .../StoryFragment.xml | 333 +++++++++--------- 9 files changed, 184 insertions(+), 191 deletions(-) diff --git a/xml/System.Collections.Generic/OrderedDictionary`2+ValueCollection.xml b/xml/System.Collections.Generic/OrderedDictionary`2+ValueCollection.xml index 07a5d9c106b..0d2b863faed 100644 --- a/xml/System.Collections.Generic/OrderedDictionary`2+ValueCollection.xml +++ b/xml/System.Collections.Generic/OrderedDictionary`2+ValueCollection.xml @@ -90,7 +90,7 @@ The zero-based index in at which copying begins. Copies the elements of the to an , starting at a particular index. To be added. - + diff --git a/xml/System.CommandLine.Help/TwoColumnHelpRow.xml b/xml/System.CommandLine.Help/TwoColumnHelpRow.xml index cfcc9f60da9..f99dfca10ce 100644 --- a/xml/System.CommandLine.Help/TwoColumnHelpRow.xml +++ b/xml/System.CommandLine.Help/TwoColumnHelpRow.xml @@ -74,7 +74,7 @@ if the current object is equal to the parameter; otherwise, . To be added. - + diff --git a/xml/System.CommandLine.Parsing/Token.xml b/xml/System.CommandLine.Parsing/Token.xml index e07e3b816db..19e1f822d4b 100644 --- a/xml/System.CommandLine.Parsing/Token.xml +++ b/xml/System.CommandLine.Parsing/Token.xml @@ -82,7 +82,7 @@ if the current object is equal to the parameter; otherwise, . To be added. - + diff --git a/xml/System.CommandLine/ArgumentArity.xml b/xml/System.CommandLine/ArgumentArity.xml index 18cbaf7296e..81baddd9ad2 100644 --- a/xml/System.CommandLine/ArgumentArity.xml +++ b/xml/System.CommandLine/ArgumentArity.xml @@ -89,7 +89,7 @@ if the current object is equal to the parameter; otherwise, . To be added. - + diff --git a/xml/System.CommandLine/Option.xml b/xml/System.CommandLine/Option.xml index 9e78464a35b..cbda2f3830b 100644 --- a/xml/System.CommandLine/Option.xml +++ b/xml/System.CommandLine/Option.xml @@ -18,9 +18,7 @@ - - A symbol defining a named parameter and a value for that parameter. - + Defines a named parameter and a value for that parameter. To be added. diff --git a/xml/System.CommandLine/Option`1.xml b/xml/System.CommandLine/Option`1.xml index efe02dda922..63ff0010ddf 100644 --- a/xml/System.CommandLine/Option`1.xml +++ b/xml/System.CommandLine/Option`1.xml @@ -71,9 +71,9 @@ To be added. To be added. - To be added. + Initializes a new instance of the class. To be added. - + @@ -96,9 +96,9 @@ To be added. To be added. To be added. - To be added. + Initializes a new instance of the class. To be added. - + @@ -121,9 +121,9 @@ To be added. To be added. To be added. - To be added. + Initializes a new instance of the class. To be added. - + @@ -148,9 +148,8 @@ To be added. To be added. To be added. - To be added. + Initializes a new instance of the class. To be added. - @@ -175,9 +174,8 @@ To be added. To be added. To be added. - To be added. + Initializes a new instance of the class. To be added. - diff --git a/xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml b/xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml index 1d63fe527e4..12cd62b85e0 100644 --- a/xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml +++ b/xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml @@ -244,7 +244,7 @@ Multiple header values associated with the same header name are considered to be if the read-only dictionary contains an element that has the specified key; otherwise, . To be added. - + @@ -304,7 +304,7 @@ Multiple header values associated with the same header name are considered to be if the collection contains the specified header; otherwise, . To be added. - + diff --git a/xml/System.Security.Cryptography.Cose/CoseHeaderMap.xml b/xml/System.Security.Cryptography.Cose/CoseHeaderMap.xml index 7c14c7d941f..0f957fe6e85 100644 --- a/xml/System.Security.Cryptography.Cose/CoseHeaderMap.xml +++ b/xml/System.Security.Cryptography.Cose/CoseHeaderMap.xml @@ -295,7 +295,7 @@ if is found in the ; otherwise, . To be added. - + @@ -326,7 +326,7 @@ if the contains an element with the key; otherwise, . To be added. - + @@ -363,7 +363,7 @@ The zero-based index in at which copying begins. Copies the elements of the to an , starting at a particular index. To be added. - + @@ -801,7 +801,7 @@ This member is an explicit interface member implementation. It can be used only To be added. To be added. To be added. - + diff --git a/xml/System.Windows.Documents.DocumentStructures/StoryFragment.xml b/xml/System.Windows.Documents.DocumentStructures/StoryFragment.xml index 5605812cff8..b2df300b399 100644 --- a/xml/System.Windows.Documents.DocumentStructures/StoryFragment.xml +++ b/xml/System.Windows.Documents.DocumentStructures/StoryFragment.xml @@ -44,132 +44,129 @@ Represents all or part of a story within an XPS document. - represents all or a portion of a story. It can never span more than one page, but it can occupy the whole of a page or share a page with other fragments. If a story is on more than one page, each part of it on each page is a separate fragment. Although stories can have discontinuous sets of fragments, no fragment can itself be discontinuous. - - Only a element can be a parent of a . The location of the elements within a indicates if the story is contained in multiple fragments, and if the additional fragments either precede or follow the current fragment. - - When a ends in the middle of some structural element; say a ``, then XPS document-producing applications must insert an appropriate end tag for the element (in this case ``) before the `` tag, even though the structure is being continued in a later fragment. (This is necessary to ensure that the element tree within the is valid XML.) The fragment that continues the story must begin with an opening tag for the interrupted structure. The entire tree of interrupted structures must be treated the same way (with one exception, discussed below): End tags must be added for every unmatched start tag above the point of interruption. - - The exception applies when the story interruption comes immediately after a `` tag, then the producing application must insert an empty table cell structure (``) at the corresponding point in the fragment that continues the story. This is necessary so that consuming applications that need to merge all fragments of a given story can use a simple algorithm to do this. - - Assume, for example, that an application wanted to add the following material to an XPS document: - -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -``` - - If a page break forces an end to the fragment just after the `` for "SomeContent", the application must create the split as shown in the following example: - -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -``` - - An application that reads the document might need to merge this content. Consider, for example, an XPS viewer with a **Copy Whole Story to Clipboard** button; or an **XPS for the Blind** application that passed stories to a voice synthesizer. Some applications that read the document may need to merge a subset of the fragments of a story. For example, a feature that copies a whole paragraph to the clipboard by triple-clicking it would need to do a merge whenever the paragraph spanned a page break, because such a paragraph would be split between two s. - - **To merge use this algorithm:** - -1. Delete the `` from the end of the first fragment to be merged and delete the `` from the beginning of the second. - -2. If the last closing tag of the first fragment is of the same type as the first opening tag of the second fragment (and they are not `` tags), delete them both. - -3. Repeat step 2 until the two fragments are in *either* of these states: - - - There is no longer a type match between the last end tag of the leading fragment the first start tag of the trailing fragment. - - - The last end tag of the leading fragment the first start tag of the trailing fragment are both `` tags. - - In the example above, if the empty cell had not been added by the producing application, then a merger of the fragments would produce a table whose first row had only one cell containing both the "SomeContent" and "MoreContent" references instead of the original first row with two cells, each containing a single reference - - When the entire story is being merged, the algorithm should be repeated for each subsequent fragment that is part of the same story. The fragments that belong to a story are indexed in the `` element. See section 9.1.15 of the XML Paper Specification (XPS) specification which you can obtain at [XPS: Specification and License Downloads](https://www.microsoft.com/download/details.aspx?id=51478). The last fragment for a given story will have a element as its last child. - - - -## Examples - The following example shows the `` part of an XML Paper Specification (XPS) document. - - :::code language="xaml" source="~/snippets/csharp/System.Windows.Documents.DocumentStructures/FigureStructure/Overview/Content/FixedPage1_structure.xaml" id="Snippetdocstructstoryfragcontent1"::: - + represents all or a portion of a story. It can never span more than one page, but it can occupy the whole of a page or share a page with other fragments. If a story is on more than one page, each part of it on each page is a separate fragment. Although stories can have discontinuous sets of fragments, no fragment can itself be discontinuous. + + Only a element can be a parent of a . The location of the elements within a indicates if the story is contained in multiple fragments, and if the additional fragments either precede or follow the current fragment. + + When a ends in the middle of some structural element; say a ``, then XPS document-producing applications must insert an appropriate end tag for the element (in this case ``) before the `` tag, even though the structure is being continued in a later fragment. (This is necessary to ensure that the element tree within the is valid XML.) The fragment that continues the story must begin with an opening tag for the interrupted structure. The entire tree of interrupted structures must be treated the same way (with one exception, discussed below): End tags must be added for every unmatched start tag above the point of interruption. + + The exception applies when the story interruption comes immediately after a `` tag, then the producing application must insert an empty table cell structure (``) at the corresponding point in the fragment that continues the story. This is necessary so that consuming applications that need to merge all fragments of a given story can use a simple algorithm to do this. + + Assume, for example, that an application wanted to add the following material to an XPS document: + +```xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + + If a page break forces an end to the fragment just after the `` for "SomeContent", the application must create the split as shown in the following example: + +```xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + + An application that reads the document might need to merge this content. Consider, for example, an XPS viewer with a **Copy Whole Story to Clipboard** button; or an **XPS for the Blind** application that passed stories to a voice synthesizer. Some applications that read the document may need to merge a subset of the fragments of a story. For example, a feature that copies a whole paragraph to the clipboard by triple-clicking it would need to do a merge whenever the paragraph spanned a page break, because such a paragraph would be split between two s. + + **To merge use this algorithm:** + +1. Delete the `` from the end of the first fragment to be merged and delete the `` from the beginning of the second. + +2. If the last closing tag of the first fragment is of the same type as the first opening tag of the second fragment (and they are not `` tags), delete them both. + +3. Repeat step 2 until the two fragments are in *either* of these states: + + - There is no longer a type match between the last end tag of the leading fragment the first start tag of the trailing fragment. + - The last end tag of the leading fragment the first start tag of the trailing fragment are both `` tags. + + In the example above, if the empty cell had not been added by the producing application, then a merger of the fragments would produce a table whose first row had only one cell containing both the "SomeContent" and "MoreContent" references instead of the original first row with two cells, each containing a single reference + + When the entire story is being merged, the algorithm should be repeated for each subsequent fragment that is part of the same story. The fragments that belong to a story are indexed in the `` element. See section 9.1.15 of the XML Paper Specification (XPS) specification which you can obtain at [XPS: Specification and License Downloads](https://www.microsoft.com/download/details.aspx?id=51478). The last fragment for a given story will have a element as its last child. + +## Examples + The following example shows the `` part of an XML Paper Specification (XPS) document. + + :::code language="xaml" source="~/snippets/csharp/System.Windows.Documents.DocumentStructures/FigureStructure/Overview/Content/FixedPage1_structure.xaml" id="Snippetdocstructstoryfragcontent1"::: + ]]> @@ -264,11 +261,11 @@ Gets or sets the name of the story fragment. A representing the name of this fragment. - ` part of an XML Paper Specification (XPS) document, see chapter 9 of the XML Paper Specification (XPS) specification which you can obtain at [XPS: Specification and License Downloads](https://www.microsoft.com/download/details.aspx?id=51478). - + ` part of an XML Paper Specification (XPS) document, see chapter 9 of the XML Paper Specification (XPS) specification which you can obtain at [XPS: Specification and License Downloads](https://www.microsoft.com/download/details.aspx?id=51478). + ]]> @@ -310,20 +307,20 @@ Gets or sets the type of fragment. A representing the type of fragment. - ` part of an XML Paper Specification (XPS) document, see chapter 9 of the XML Paper Specification (XPS) specification which you can obtain at [XPS: Specification and License Downloads](https://www.microsoft.com/download/details.aspx?id=51478). - - - -## Examples - The following example shows the `FragmentType` attribute of the `` part of an XML Paper Specification (XPS) document. - - :::code language="xaml" source="~/snippets/csharp/System.Windows.Documents.DocumentStructures/FigureStructure/Overview/Content/FixedPage1_structure.xaml" id="Snippetdocstructstoryfragcontent1"::: - + ` part of an XML Paper Specification (XPS) document, see chapter 9 of the XML Paper Specification (XPS) specification which you can obtain at [XPS: Specification and License Downloads](https://www.microsoft.com/download/details.aspx?id=51478). + + + +## Examples + The following example shows the `FragmentType` attribute of the `` part of an XML Paper Specification (XPS) document. + + :::code language="xaml" source="~/snippets/csharp/System.Windows.Documents.DocumentStructures/FigureStructure/Overview/Content/FixedPage1_structure.xaml" id="Snippetdocstructstoryfragcontent1"::: + ]]> @@ -364,20 +361,20 @@ Gets or sets the name of the story. A representing the name of the story. - ` element. See section 9.1.15 of the XML Paper Specification (XPS) specification which you can obtain at [XPS: Specification and License Downloads](https://www.microsoft.com/download/details.aspx?id=51478). - - This property can be unspecified if is Header or Footer. - - - -## Examples - The following example shows the `StoryName` attribute of the `` part of an XML Paper Specification (XPS) document. - - :::code language="xaml" source="~/snippets/csharp/System.Windows.Documents.DocumentStructures/FigureStructure/Overview/Content/FixedPage1_structure.xaml" id="Snippetdocstructstoryfragcontent1"::: - + ` element. See section 9.1.15 of the XML Paper Specification (XPS) specification which you can obtain at [XPS: Specification and License Downloads](https://www.microsoft.com/download/details.aspx?id=51478). + + This property can be unspecified if is Header or Footer. + + + +## Examples + The following example shows the `StoryName` attribute of the `` part of an XML Paper Specification (XPS) document. + + :::code language="xaml" source="~/snippets/csharp/System.Windows.Documents.DocumentStructures/FigureStructure/Overview/Content/FixedPage1_structure.xaml" id="Snippetdocstructstoryfragcontent1"::: + ]]> @@ -474,15 +471,15 @@ The child that is added. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. - . - - There must be at least one child of the and the children can only be of these types: , , , , , and . - - A can only be the first or last child of a . - + . + + There must be at least one child of the and the children can only be of these types: , , , , , and . + + A can only be the first or last child of a . + ]]>