Skip to content

Commit fffe1c4

Browse files
chenkenntchenkennt
committed
fix yaml metadata
1. add references for exceptions 2. add summary for classes in namespace.yml
1 parent 9ebeac9 commit fffe1c4

File tree

692 files changed

+15739
-837
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

692 files changed

+15739
-837
lines changed

‎api/Microsoft.CSharp.RuntimeBinder.yml

+5-24
Original file line numberDiff line numberDiff line change
@@ -37,56 +37,37 @@ references:
3737
name: CSharpArgumentInfo
3838
fullName: Microsoft.CSharp.RuntimeBinder.CSharpArgumentInfo
3939
type: Class
40-
summary: >-
41-
Represents information about C# dynamic operations that are specific to particular arguments at a call site.
42-
43-
Instances of this class are generated by the C# compiler.
40+
summary: Represents information about C# dynamic operations that are specific to particular arguments at a call site. Instances of this class are generated by the C# compiler.
4441
- uid: Microsoft.CSharp.RuntimeBinder.CSharpArgumentInfoFlags
4542
parent: Microsoft.CSharp.RuntimeBinder
4643
isExternal: false
4744
href: Microsoft.CSharp.RuntimeBinder.CSharpArgumentInfoFlags.yml
4845
name: CSharpArgumentInfoFlags
4946
fullName: Microsoft.CSharp.RuntimeBinder.CSharpArgumentInfoFlags
5047
type: Enum
51-
summary: >-
52-
Represents information about C# dynamic operations that are specific to particular arguments at a call site.
53-
54-
Instances of this class are generated by the C# compiler.
48+
summary: Represents information about C# dynamic operations that are specific to particular arguments at a call site. Instances of this class are generated by the C# compiler.
5549
- uid: Microsoft.CSharp.RuntimeBinder.CSharpBinderFlags
5650
parent: Microsoft.CSharp.RuntimeBinder
5751
isExternal: false
5852
href: Microsoft.CSharp.RuntimeBinder.CSharpBinderFlags.yml
5953
name: CSharpBinderFlags
6054
fullName: Microsoft.CSharp.RuntimeBinder.CSharpBinderFlags
6155
type: Enum
62-
summary: >-
63-
Represents information about C# dynamic operations that are not specific to particular arguments at a call site.
64-
65-
Instances of this class are generated by the C# compiler.
56+
summary: Represents information about C# dynamic operations that are not specific to particular arguments at a call site. Instances of this class are generated by the C# compiler.
6657
- uid: Microsoft.CSharp.RuntimeBinder.RuntimeBinderException
6758
isExternal: false
6859
href: Microsoft.CSharp.RuntimeBinder.RuntimeBinderException.yml
6960
name: RuntimeBinderException
7061
fullName: Microsoft.CSharp.RuntimeBinder.RuntimeBinderException
7162
type: Class
72-
summary: >-
73-
Represents an error that occurs while processing a dynamic bind in the C# runtime binder. Exceptions of this type differ from @'Microsoft.CSharp.RuntimeBinder.RuntimeBinderInternalCompilerException' in that
74-
75-
@'Microsoft.CSharp.RuntimeBinder.RuntimeBinderException' represents a failure to bind in the sense of a usual compiler error, whereas @'Microsoft.CSharp.RuntimeBinder.RuntimeBinderInternalCompilerException'
76-
77-
represents a malfunctioning of the runtime binder itself.
63+
summary: Represents an error that occurs when a dynamic bind in the C# runtime binder is processed.
7864
- uid: Microsoft.CSharp.RuntimeBinder.RuntimeBinderInternalCompilerException
7965
isExternal: false
8066
href: Microsoft.CSharp.RuntimeBinder.RuntimeBinderInternalCompilerException.yml
8167
name: RuntimeBinderInternalCompilerException
8268
fullName: Microsoft.CSharp.RuntimeBinder.RuntimeBinderInternalCompilerException
8369
type: Class
84-
summary: >-
85-
Represents an error that occurs while processing a dynamic bind in the C# runtime binder. Exceptions of this type differ from @'Microsoft.CSharp.RuntimeBinder.RuntimeBinderException' in that
86-
87-
@'Microsoft.CSharp.RuntimeBinder.RuntimeBinderException' represents a failure to bind in the sense of a usual compiler error, whereas @'Microsoft.CSharp.RuntimeBinder.RuntimeBinderInternalCompilerException'
88-
89-
represents a malfunctioning of the runtime binder itself.
70+
summary: Represents an error that occurs when a dynamic bind in the C# runtime binder is processed.
9071
- uid: Microsoft.CSharp.RuntimeBinder
9172
isExternal: false
9273
name: Microsoft.CSharp.RuntimeBinder

‎api/Microsoft.Win32.Registry.yml

+44
Original file line numberDiff line numberDiff line change
@@ -531,3 +531,47 @@ references:
531531
name: RegistryValueKind
532532
fullName: Microsoft.Win32.RegistryValueKind
533533
type: Enum
534+
- uid: System.ObjectDisposedException
535+
isExternal: false
536+
href: System.ObjectDisposedException.yml
537+
name: ObjectDisposedException
538+
fullName: System.ObjectDisposedException
539+
type: Class
540+
summary: The exception that is thrown when an operation is performed on a disposed object.
541+
- uid: System.Security.SecurityException
542+
isExternal: false
543+
href: System.Security.SecurityException.yml
544+
name: SecurityException
545+
fullName: System.Security.SecurityException
546+
type: Class
547+
summary: The exception that is thrown when a security error is detected.
548+
- uid: System.IO.IOException
549+
parent: System.IO
550+
isExternal: false
551+
href: System.IO.IOException.yml
552+
name: IOException
553+
fullName: System.IO.IOException
554+
type: Class
555+
summary: The exception that is thrown when an I/O error occurs.
556+
- uid: System.ArgumentException
557+
parent: System
558+
isExternal: false
559+
href: System.ArgumentException.yml
560+
name: ArgumentException
561+
fullName: System.ArgumentException
562+
type: Class
563+
summary: The exception that is thrown when one of the arguments provided to a method is not valid.
564+
- uid: System.ArgumentNullException
565+
isExternal: false
566+
href: System.ArgumentNullException.yml
567+
name: ArgumentNullException
568+
fullName: System.ArgumentNullException
569+
type: Class
570+
summary: The exception that is thrown when a null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.
571+
- uid: System.UnauthorizedAccessException
572+
isExternal: false
573+
href: System.UnauthorizedAccessException.yml
574+
name: UnauthorizedAccessException
575+
fullName: System.UnauthorizedAccessException
576+
type: Class
577+
summary: The exception that is thrown when the operating system denies access because of an I/O error or a specific type of security error.

‎api/Microsoft.Win32.RegistryKey.yml

+52
Original file line numberDiff line numberDiff line change
@@ -1453,3 +1453,55 @@ references:
14531453
fullName: (
14541454
- name: )
14551455
fullName: )
1456+
- uid: System.ArgumentNullException
1457+
isExternal: false
1458+
href: System.ArgumentNullException.yml
1459+
name: ArgumentNullException
1460+
fullName: System.ArgumentNullException
1461+
type: Class
1462+
summary: The exception that is thrown when a null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.
1463+
- uid: System.Security.SecurityException
1464+
isExternal: false
1465+
href: System.Security.SecurityException.yml
1466+
name: SecurityException
1467+
fullName: System.Security.SecurityException
1468+
type: Class
1469+
summary: The exception that is thrown when a security error is detected.
1470+
- uid: System.ObjectDisposedException
1471+
isExternal: false
1472+
href: System.ObjectDisposedException.yml
1473+
name: ObjectDisposedException
1474+
fullName: System.ObjectDisposedException
1475+
type: Class
1476+
summary: The exception that is thrown when an operation is performed on a disposed object.
1477+
- uid: System.UnauthorizedAccessException
1478+
isExternal: false
1479+
href: System.UnauthorizedAccessException.yml
1480+
name: UnauthorizedAccessException
1481+
fullName: System.UnauthorizedAccessException
1482+
type: Class
1483+
summary: The exception that is thrown when the operating system denies access because of an I/O error or a specific type of security error.
1484+
- uid: System.IO.IOException
1485+
parent: System.IO
1486+
isExternal: false
1487+
href: System.IO.IOException.yml
1488+
name: IOException
1489+
fullName: System.IO.IOException
1490+
type: Class
1491+
summary: The exception that is thrown when an I/O error occurs.
1492+
- uid: System.ArgumentException
1493+
parent: System
1494+
isExternal: false
1495+
href: System.ArgumentException.yml
1496+
name: ArgumentException
1497+
fullName: System.ArgumentException
1498+
type: Class
1499+
summary: The exception that is thrown when one of the arguments provided to a method is not valid.
1500+
- uid: System.InvalidOperationException
1501+
parent: System
1502+
isExternal: false
1503+
href: System.InvalidOperationException.yml
1504+
name: InvalidOperationException
1505+
fullName: System.InvalidOperationException
1506+
type: Class
1507+
summary: The exception that is thrown when a method call is invalid for the object's current state.

‎api/Microsoft.Win32.SafeHandles.yml

+13
Original file line numberDiff line numberDiff line change
@@ -37,87 +37,100 @@ references:
3737
name: SafeProcessHandle
3838
fullName: Microsoft.Win32.SafeHandles.SafeProcessHandle
3939
type: Class
40+
summary: Provides a managed wrapper for a process handle.
4041
- uid: Microsoft.Win32.SafeHandles.SafeAccessTokenHandle
4142
parent: Microsoft.Win32.SafeHandles
4243
isExternal: false
4344
href: Microsoft.Win32.SafeHandles.SafeAccessTokenHandle.yml
4445
name: SafeAccessTokenHandle
4546
fullName: Microsoft.Win32.SafeHandles.SafeAccessTokenHandle
4647
type: Class
48+
summary: Provides a safe handle to a Windows thread or process access token. For more information see Access Tokens
4749
- uid: Microsoft.Win32.SafeHandles.SafePipeHandle
4850
parent: Microsoft.Win32.SafeHandles
4951
isExternal: false
5052
href: Microsoft.Win32.SafeHandles.SafePipeHandle.yml
5153
name: SafePipeHandle
5254
fullName: Microsoft.Win32.SafeHandles.SafePipeHandle
5355
type: Class
56+
summary: Represents a wrapper class for a pipe handle.
5457
- uid: Microsoft.Win32.SafeHandles.SafeFileHandle
5558
parent: Microsoft.Win32.SafeHandles
5659
isExternal: false
5760
href: Microsoft.Win32.SafeHandles.SafeFileHandle.yml
5861
name: SafeFileHandle
5962
fullName: Microsoft.Win32.SafeHandles.SafeFileHandle
6063
type: Class
64+
summary: Represents a wrapper class for a file handle.
6165
- uid: Microsoft.Win32.SafeHandles.SafeWaitHandle
6266
parent: Microsoft.Win32.SafeHandles
6367
isExternal: false
6468
href: Microsoft.Win32.SafeHandles.SafeWaitHandle.yml
6569
name: SafeWaitHandle
6670
fullName: Microsoft.Win32.SafeHandles.SafeWaitHandle
6771
type: Class
72+
summary: Represents a wrapper class for a wait handle.
6873
- uid: Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid
6974
parent: Microsoft.Win32.SafeHandles
7075
isExternal: false
7176
href: Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid.yml
7277
name: SafeHandleZeroOrMinusOneIsInvalid
7378
fullName: Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid
7479
type: Class
80+
summary: Provides a base class for Win32 safe handle implementations in which the value of either 0 or -1 indicates an invalid handle.
7581
- uid: Microsoft.Win32.SafeHandles.SafeHandleMinusOneIsInvalid
7682
isExternal: false
7783
href: Microsoft.Win32.SafeHandles.SafeHandleMinusOneIsInvalid.yml
7884
name: SafeHandleMinusOneIsInvalid
7985
fullName: Microsoft.Win32.SafeHandles.SafeHandleMinusOneIsInvalid
8086
type: Class
87+
summary: Provides a base class for Win32 safe handle implementations in which the value of -1 indicates an invalid handle.
8188
- uid: Microsoft.Win32.SafeHandles.CriticalHandleZeroOrMinusOneIsInvalid
8289
isExternal: false
8390
href: Microsoft.Win32.SafeHandles.CriticalHandleZeroOrMinusOneIsInvalid.yml
8491
name: CriticalHandleZeroOrMinusOneIsInvalid
8592
fullName: Microsoft.Win32.SafeHandles.CriticalHandleZeroOrMinusOneIsInvalid
8693
type: Class
94+
summary: Provides a base class for Win32 critical handle implementations in which the value of either 0 or -1 indicates an invalid handle.
8795
- uid: Microsoft.Win32.SafeHandles.CriticalHandleMinusOneIsInvalid
8896
isExternal: false
8997
href: Microsoft.Win32.SafeHandles.CriticalHandleMinusOneIsInvalid.yml
9098
name: CriticalHandleMinusOneIsInvalid
9199
fullName: Microsoft.Win32.SafeHandles.CriticalHandleMinusOneIsInvalid
92100
type: Class
101+
summary: Provides a base class for Win32 critical handle implementations in which the value of -1 indicates an invalid handle.
93102
- uid: Microsoft.Win32.SafeHandles.SafeRegistryHandle
94103
parent: Microsoft.Win32.SafeHandles
95104
isExternal: false
96105
href: Microsoft.Win32.SafeHandles.SafeRegistryHandle.yml
97106
name: SafeRegistryHandle
98107
fullName: Microsoft.Win32.SafeHandles.SafeRegistryHandle
99108
type: Class
109+
summary: Represents a safe handle to the Windows registry.
100110
- uid: Microsoft.Win32.SafeHandles.SafeX509ChainHandle
101111
parent: Microsoft.Win32.SafeHandles
102112
isExternal: false
103113
href: Microsoft.Win32.SafeHandles.SafeX509ChainHandle.yml
104114
name: SafeX509ChainHandle
105115
fullName: Microsoft.Win32.SafeHandles.SafeX509ChainHandle
106116
type: Class
117+
summary: Provides a wrapper class that represents the handle of an X.509 chain object. For more information, see @'System.Security.Cryptography.X509Certificates.X509Chain'.
107118
- uid: Microsoft.Win32.SafeHandles.SafeMemoryMappedViewHandle
108119
parent: Microsoft.Win32.SafeHandles
109120
isExternal: false
110121
href: Microsoft.Win32.SafeHandles.SafeMemoryMappedViewHandle.yml
111122
name: SafeMemoryMappedViewHandle
112123
fullName: Microsoft.Win32.SafeHandles.SafeMemoryMappedViewHandle
113124
type: Class
125+
summary: Provides a safe handle that represents a view of a block of unmanaged memory for random access.
114126
- uid: Microsoft.Win32.SafeHandles.SafeMemoryMappedFileHandle
115127
parent: Microsoft.Win32.SafeHandles
116128
isExternal: false
117129
href: Microsoft.Win32.SafeHandles.SafeMemoryMappedFileHandle.yml
118130
name: SafeMemoryMappedFileHandle
119131
fullName: Microsoft.Win32.SafeHandles.SafeMemoryMappedFileHandle
120132
type: Class
133+
summary: Provides a safe handle that represents a memory-mapped file for sequential access.
121134
- uid: Microsoft.Win32.SafeHandles
122135
isExternal: false
123136
name: Microsoft.Win32.SafeHandles

‎api/Microsoft.Win32.yml

+8
Original file line numberDiff line numberDiff line change
@@ -31,55 +31,63 @@ references:
3131
name: Registry
3232
fullName: Microsoft.Win32.Registry
3333
type: Class
34+
summary: Provides @'Microsoft.Win32.RegistryKey' objects that represent the root keys in the Windows registry, and static methods to access key/value pairs.
3435
- uid: Microsoft.Win32.RegistryHive
3536
parent: Microsoft.Win32
3637
isExternal: false
3738
href: Microsoft.Win32.RegistryHive.yml
3839
name: RegistryHive
3940
fullName: Microsoft.Win32.RegistryHive
4041
type: Enum
42+
summary: Represents the possible values for a top-level node on a foreign machine.
4143
- uid: Microsoft.Win32.RegistryKey
4244
parent: Microsoft.Win32
4345
isExternal: false
4446
href: Microsoft.Win32.RegistryKey.yml
4547
name: RegistryKey
4648
fullName: Microsoft.Win32.RegistryKey
4749
type: Class
50+
summary: Represents a key-level node in the Windows registry. This class is a registry encapsulation.
4851
- uid: Microsoft.Win32.RegistryValueOptions
4952
parent: Microsoft.Win32
5053
isExternal: false
5154
href: Microsoft.Win32.RegistryValueOptions.yml
5255
name: RegistryValueOptions
5356
fullName: Microsoft.Win32.RegistryValueOptions
5457
type: Enum
58+
summary: Specifies optional behavior when retrieving name/value pairs from a registry key.
5559
- uid: Microsoft.Win32.RegistryKeyPermissionCheck
5660
parent: Microsoft.Win32
5761
isExternal: false
5862
href: Microsoft.Win32.RegistryKeyPermissionCheck.yml
5963
name: RegistryKeyPermissionCheck
6064
fullName: Microsoft.Win32.RegistryKeyPermissionCheck
6165
type: Enum
66+
summary: Specifies whether security checks are performed when opening registry keys and accessing their name/value pairs.
6267
- uid: Microsoft.Win32.RegistryOptions
6368
parent: Microsoft.Win32
6469
isExternal: false
6570
href: Microsoft.Win32.RegistryOptions.yml
6671
name: RegistryOptions
6772
fullName: Microsoft.Win32.RegistryOptions
6873
type: Enum
74+
summary: Specifies options to use when creating a registry key.
6975
- uid: Microsoft.Win32.RegistryValueKind
7076
parent: Microsoft.Win32
7177
isExternal: false
7278
href: Microsoft.Win32.RegistryValueKind.yml
7379
name: RegistryValueKind
7480
fullName: Microsoft.Win32.RegistryValueKind
7581
type: Enum
82+
summary: Specifies the data types to use when storing values in the registry, or identifies the data type of a value in the registry.
7683
- uid: Microsoft.Win32.RegistryView
7784
parent: Microsoft.Win32
7885
isExternal: false
7986
href: Microsoft.Win32.RegistryView.yml
8087
name: RegistryView
8188
fullName: Microsoft.Win32.RegistryView
8289
type: Enum
90+
summary: Specifies which registry view to target on a 64-bit operating system.
8391
- uid: Microsoft.Win32
8492
isExternal: false
8593
name: Microsoft.Win32

0 commit comments

Comments
 (0)