Skip to content

Commit e9678a9

Browse files
committed
fix paramrefs for System.IO
1 parent 6cde200 commit e9678a9

18 files changed

+412
-440
lines changed

xml/System.IO.Compression/ZipFileExtensions.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -385,24 +385,24 @@ This method creates the directory specified by `destinationDirectoryName`. The m
385385
]]></format>
386386
</remarks>
387387
<exception cref="T:System.ArgumentException">
388-
<paramref name="destinationArchiveFileName" /> is a zero-length string, contains only whitespace,
388+
<paramref name="destinationDirectoryName" /> is a zero-length string, contains only whitespace,
389389
or contains one or more invalid characters as defined by <see cref="F:System.IO.Path.InvalidPathChars" />.</exception>
390390
<exception cref="T:System.ArgumentNullException">
391-
<paramref name="destinationArchiveFileName" /> is <see langword="null" />.</exception>
391+
<paramref name="destinationDirectoryName" /> is <see langword="null" />.</exception>
392392
<exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length. </exception>
393393
<exception cref="T:System.IO.DirectoryNotFoundException">The specified path is invalid (for example, it is on an unmapped drive).</exception>
394394
<exception cref="T:System.IO.IOException">The name of a <see cref="T:System.IO.Compression.ZipArchiveEntry" /> is zero-length, contains only whitespace, or contains one or more invalid characters as defined by <see cref="F:System.IO.Path.InvalidPathChars" />.
395395

396396
-or-
397397

398-
Extracting a <see cref="T:System.IO.Compression.ZipArchiveEntry" /> would have resulted in a destination file that is outside <paramref name="destinationArchiveFileName" /> (for example, if the entry name contains parent directory accessors).
398+
Extracting a <see cref="T:System.IO.Compression.ZipArchiveEntry" /> would have resulted in a destination file that is outside <paramref name="destinationDirectoryName" /> (for example, if the entry name contains parent directory accessors).
399399

400400
-or-
401401

402402
A <see cref="T:System.IO.Compression.ZipArchiveEntry" /> has the same name as an already extracted entry from the same archive.</exception>
403403
<exception cref="T:System.UnauthorizedAccessException">The caller does not have the required permission.</exception>
404404
<exception cref="T:System.NotSupportedException">
405-
<paramref name="destinationArchiveFileName" /> is in an invalid format. </exception>
405+
<paramref name="destinationDirectoryName" /> is in an invalid format.</exception>
406406
<exception cref="T:System.IO.InvalidDataException">A <see cref="T:System.IO.Compression.ZipArchiveEntry" /> was not found or was corrupt.
407407

408408
-or-

xml/System.IO.IsolatedStorage/IsolatedStorageFile.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1949,7 +1949,7 @@
19491949
]]></format>
19501950
</remarks>
19511951
<exception cref="T:System.Security.SecurityException">Sufficient isolated storage permissions have not been granted.</exception>
1952-
<exception cref="T:System.ArgumentNullException">The <paramref name="applicationEvidence" /> identity has not been passed in.</exception>
1952+
<exception cref="T:System.ArgumentNullException">The <paramref name="applicationEvidenceType" /> identity has not been passed in.</exception>
19531953
<exception cref="T:System.ArgumentException">The <paramref name="scope" /> is invalid.</exception>
19541954
<exception cref="T:System.IO.IsolatedStorage.IsolatedStorageException">An isolated storage location cannot be initialized.
19551955

@@ -2804,9 +2804,9 @@
28042804
]]></format>
28052805
</remarks>
28062806
<exception cref="T:System.ArgumentException">
2807-
<paramref name="sourceFileName" /> or <paramref name="destinationFileName" /> is a zero-length string, contains only white space, or contains one or more invalid characters defined by the <see cref="M:System.IO.Path.GetInvalidPathChars" /> method.</exception>
2807+
<paramref name="sourceDirectoryName" /> or <paramref name="destinationDirectoryName" /> is a zero-length string, contains only white space, or contains one or more invalid characters defined by the <see cref="M:System.IO.Path.GetInvalidPathChars" /> method.</exception>
28082808
<exception cref="T:System.ArgumentNullException">
2809-
<paramref name="sourceFileName" /> or <paramref name="destinationFileName" /> is <see langword="null" />.</exception>
2809+
<paramref name="sourceDirectoryName" /> or <paramref name="destinationDirectoryName" /> is <see langword="null" />.</exception>
28102810
<exception cref="T:System.InvalidOperationException">The isolated store has been closed.</exception>
28112811
<exception cref="T:System.ObjectDisposedException">The isolated store has been disposed.</exception>
28122812
<exception cref="T:System.IO.DirectoryNotFoundException">

xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,7 @@
480480
<param name="access">A bitwise combination of the <see cref="T:System.IO.FileAccess" /> values.</param>
481481
<param name="share">A bitwise combination of the <see cref="T:System.IO.FileShare" /> values.</param>
482482
<param name="bufferSize">The <see cref="T:System.IO.FileStream" /> buffer size.</param>
483-
<summary>Initializes a new instance of the <see cref="T:System.IO.IsolatedStorage.IsolatedStorageFileStream" /> class giving access to the file designated by <paramref name="path" />, in the specified <paramref name="mode" />, with the specified file <paramref name="access" />, using the file sharing mode specified by <paramref name="share" />, with the <paramref name="buffersize" /> specified.</summary>
483+
<summary>Initializes a new instance of the <see cref="T:System.IO.IsolatedStorage.IsolatedStorageFileStream" /> class giving access to the file designated by <paramref name="path" />, in the specified <paramref name="mode" />, with the specified file <paramref name="access" />, using the file sharing mode specified by <paramref name="share" />, with the <paramref name="bufferSize" /> specified.</summary>
484484
<remarks>
485485
<format type="text/markdown"><![CDATA[
486486
@@ -640,17 +640,15 @@
640640
<param name="share">A bitwise combination of the <see cref="T:System.IO.FileShare" /> values.</param>
641641
<param name="bufferSize">The <see cref="T:System.IO.FileStream" /> buffer size.</param>
642642
<param name="isf">The <see cref="T:System.IO.IsolatedStorage.IsolatedStorageFile" /> in which to open the <see cref="T:System.IO.IsolatedStorage.IsolatedStorageFileStream" />.</param>
643-
<summary>Initializes a new instance of the <see cref="T:System.IO.IsolatedStorage.IsolatedStorageFileStream" /> class giving access to the file designated by <paramref name="path" />, in the specified <paramref name="mode" />, with the specified file <paramref name="access" />, using the file sharing mode specified by <paramref name="share" />, with the <paramref name="buffersize" /> specified, and in the context of the <see cref="T:System.IO.IsolatedStorage.IsolatedStorageFile" /> specified by <paramref name="isf" />.</summary>
643+
<summary>Initializes a new instance of the <see cref="T:System.IO.IsolatedStorage.IsolatedStorageFileStream" /> class giving access to the file designated by <paramref name="path" />, in the specified <paramref name="mode" />, with the specified file <paramref name="access" />, using the file sharing mode specified by <paramref name="share" />, with the <paramref name="bufferSize" /> specified, and in the context of the <see cref="T:System.IO.IsolatedStorage.IsolatedStorageFile" /> specified by <paramref name="isf" />.</summary>
644644
<remarks>
645645
<format type="text/markdown"><![CDATA[
646646
647647
## Remarks
648648
The `mode` parameter indicates whether a new file should be created or an existing one used. The `access` parameter includes read-only, read/write, and write-only.
649649
650650
> [!CAUTION]
651-
> When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and can cause an exception to be thrown.
652-
653-
651+
> When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and can cause an exception to be thrown.
654652
655653
## Examples
656654
The following code example demonstrates the use of this constructor. For the complete context of this example, see the <xref:System.IO.IsolatedStorage.IsolatedStorageFileStream> overview.

xml/System.IO.Packaging/PackUriHelper.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1024,7 +1024,7 @@ This method does not inspect the part contents; it is based solely on the name.
10241024
<param name="sourcePartUri">The URI of the source part, or "/" to designate the <see cref="T:System.IO.Packaging.Package" /> root.</param>
10251025
<param name="targetUri">The relative URI to the target part.</param>
10261026
<summary>Returns a part URI given a source part URI and a URI with a relative path to a target part.</summary>
1027-
<returns>The URI of the target part resolved between the specified <paramref name="SourcePartUri" /> and the <paramref name="targetUri" /> parameters.</returns>
1027+
<returns>The URI of the target part resolved between the specified <paramref name="sourcePartUri" /> and the <paramref name="targetUri" /> parameters.</returns>
10281028
<remarks>
10291029
<format type="text/markdown"><![CDATA[
10301030

xml/System.IO.Packaging/PackagePart.xml

Lines changed: 25 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -487,9 +487,8 @@
487487
## Remarks
488488
A part-level relationship defines an association between this part and a target part or resource. A part-level relationship can be one of two forms.
489489
490-
- Between a source <xref:System.IO.Packaging.PackagePart> to a target <xref:System.IO.Packaging.PackagePart> inside the <xref:System.IO.Packaging.Package>.
491-
492-
- Between a source <xref:System.IO.Packaging.PackagePart> to a target resource outside the package.
490+
- Between a source <xref:System.IO.Packaging.PackagePart> to a target <xref:System.IO.Packaging.PackagePart> inside the <xref:System.IO.Packaging.Package>.
491+
- Between a source <xref:System.IO.Packaging.PackagePart> to a target resource outside the package.
493492
494493
In a part-relationship the source part is considered the "owner" of the relationship. When the source part is deleted, all the relationships owned by the part are also deleted. The process of creating or deleting the relationship does not physically alter the target part or resource in any way.
495494
@@ -503,16 +502,16 @@
503502
504503
`relationshipType` must be a URI that is formed according to the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. Different package types can define different part-level relationship types. The following table shows the part-level `relationshipType` URIs defined for documents that conform to the *Open XML Paper Specification (XPS)*.
505504
506-
|XPS Document Part-Level Relationship|Relationship Type URI|
507-
|-------------------------------------------|---------------------------|
508-
|Digital Signature Definitions|`http://schemas.microsoft.com/xps/2005/06/signature-definitions`|
509-
|DiscardControl|`http://schemas.microsoft.com/xps/2005/06/discard-control`|
510-
|DocumentStructure|`http://schemas.microsoft.com/xps/2005/06/documentstructure`|
511-
|PrintTicket|`http://schemas.microsoft.com/xps/2005/06/printticket`|
512-
|Required Resource|`http://schemas.microsoft.com/xps/2005/06/required-resource`|
513-
|Restricted Font|`http://schemas.microsoft.com/xps/2005/06/restricted-font`|
514-
|StartPart|`http://schemas.microsoft.com/xps/2005/06/fixedrepresentation`|
515-
|StoryFragments|`http://schemas.microsoft.com/xps/2005/06/storyfragments`|
505+
| XPS Document Part-Level Relationship | Relationship Type URI |
506+
|--------------------------------------|------------------------------------------------------------------|
507+
| Digital Signature Definitions | `http://schemas.microsoft.com/xps/2005/06/signature-definitions` |
508+
| DiscardControl | `http://schemas.microsoft.com/xps/2005/06/discard-control` |
509+
| DocumentStructure | `http://schemas.microsoft.com/xps/2005/06/documentstructure` |
510+
| PrintTicket | `http://schemas.microsoft.com/xps/2005/06/printticket` |
511+
| Required Resource | `http://schemas.microsoft.com/xps/2005/06/required-resource` |
512+
| Restricted Font | `http://schemas.microsoft.com/xps/2005/06/restricted-font` |
513+
| StartPart | `http://schemas.microsoft.com/xps/2005/06/fixedrepresentation` |
514+
| StoryFragments | `http://schemas.microsoft.com/xps/2005/06/storyfragments` |
516515
517516
For more information about package relationships see section 1.3 of the *Open Packaging Conventions (OPC)* specification available for download at <https://www.ecma-international.org/publications-and-standards/standards/ecma-376/>.
518517
@@ -596,9 +595,8 @@
596595
## Remarks
597596
A part-level relationship defines an association between this part and a target part or resource. A part-level relationship can be one of two forms.
598597
599-
- Between a source <xref:System.IO.Packaging.PackagePart> to a target <xref:System.IO.Packaging.PackagePart> inside the <xref:System.IO.Packaging.Package>.
600-
601-
- Between a source <xref:System.IO.Packaging.PackagePart> to a target resource outside the package.
598+
- Between a source <xref:System.IO.Packaging.PackagePart> to a target <xref:System.IO.Packaging.PackagePart> inside the <xref:System.IO.Packaging.Package>.
599+
- Between a source <xref:System.IO.Packaging.PackagePart> to a target resource outside the package.
602600
603601
In a part-relationship the source part is considered the "owner" of the relationship. When the source part is deleted, all the relationships owned by the part are also deleted. The process of creating or deleting the relationship does not physically alter the target part or resource in any way.
604602
@@ -614,16 +612,16 @@
614612
615613
`relationshipType` must be a URI that is formed according to the [RFC 3986](https://tools.ietf.org/html/rfc3986) *Uniform Resource Identifier (URI) Generic Syntax* specification. Different package types can define different part-level relationship types. The following table shows the part-level `relationshipType` URIs defined for documents that conform to the *Open XML Paper Specification (XPS)*.
616614
617-
|XPS Document Part-Level Relationship|Relationship Type URI|
618-
|-------------------------------------------|---------------------------|
619-
|Digital Signature Definitions|http://schemas.microsoft.com/xps/2005/06/signature-definitions|
620-
|DiscardControl|http://schemas.microsoft.com/xps/2005/06/discard-control|
621-
|DocumentStructure|http://schemas.microsoft.com/xps/2005/06/documentstructure|
622-
|PrintTicket|http://schemas.microsoft.com/xps/2005/06/printticket|
623-
|Required Resource|http://schemas.microsoft.com/xps/2005/06/required-resource|
624-
|Restricted Font|http://schemas.microsoft.com/xps/2005/06/restricted-font|
625-
|StartPart|http://schemas.microsoft.com/xps/2005/06/fixedrepresentation|
626-
|StoryFragments|http://schemas.microsoft.com/xps/2005/06/storyfragments|
615+
| XPS Document Part-Level Relationship | Relationship Type URI |
616+
|--------------------------------------|----------------------------------------------------------------|
617+
| Digital Signature Definitions | http://schemas.microsoft.com/xps/2005/06/signature-definitions |
618+
| DiscardControl | http://schemas.microsoft.com/xps/2005/06/discard-control |
619+
| DocumentStructure | http://schemas.microsoft.com/xps/2005/06/documentstructure |
620+
| PrintTicket | http://schemas.microsoft.com/xps/2005/06/printticket |
621+
| Required Resource | http://schemas.microsoft.com/xps/2005/06/required-resource |
622+
| Restricted Font | http://schemas.microsoft.com/xps/2005/06/restricted-font |
623+
| StartPart | http://schemas.microsoft.com/xps/2005/06/fixedrepresentation |
624+
| StoryFragments | http://schemas.microsoft.com/xps/2005/06/storyfragments |
627625
628626
For more information about package relationships see section 1.3 of the *Open Packaging Conventions (OPC)* specification available for download at <https://www.ecma-international.org/publications-and-standards/standards/ecma-376/>.
629627
@@ -803,7 +801,7 @@
803801
<format type="text/markdown"><![CDATA[
804802
805803
## Remarks
806-
`id` must be a valid XML identifier. The `id` type is xsd:ID and must follow the naming conventions prescribed in the *XML Schema Part 2: Datatypes* specification (see [https://www.w3.org/TR/xmlschema-2/#ID](https://www.w3.org/TR/xmlschema-2/#ID)).
804+
`id` must be a valid XML identifier. The `id` type is xsd:ID and must follow the naming conventions prescribed in the *XML Schema Part 2: Datatypes* specification (see [https://www.w3.org/TR/xmlschema-2/#ID](https://www.w3.org/TR/xmlschema-2/#ID)).
807805
808806
You can use the <xref:System.IO.Packaging.PackagePart.RelationshipExists%2A> method to determine if a relationship with a specified <xref:System.IO.Packaging.PackageRelationship.Id%2A> is owned by this part.
809807
@@ -813,8 +811,6 @@
813811
<paramref name="id" /> is <see langword="null" />.</exception>
814812
<exception cref="T:System.Xml.XmlException">
815813
<paramref name="id" /> is not a valid XML identifier.</exception>
816-
<exception cref="T:System.ArgumentException">
817-
<paramref name="relationshipType" /> is an empty string.</exception>
818814
<exception cref="T:System.InvalidOperationException">The part has been deleted.
819815

820816
-or-

0 commit comments

Comments
 (0)