Skip to content

Commit a22e774

Browse files
author
Colin Robertson
committed
Initial pass on fixing parameters
1 parent 3955e2c commit a22e774

File tree

267 files changed

+9484
-9483
lines changed

Some content is hidden

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

267 files changed

+9484
-9483
lines changed

‎docs/atl/reference/atl-text-encoding-functions.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -465,20 +465,20 @@ inline BOOL QPDecode(
465465

466466
### Parameters
467467

468-
[in] *pbSrcData*
469-
The buffer containing the data to be decoded.
468+
*pbSrcData*<br/>
469+
[in] The buffer containing the data to be decoded.
470470

471-
[in] *nSrcLen*
472-
The length in bytes of *pbSrcData*.
471+
*nSrcLen*<br/>
472+
[in] The length in bytes of *pbSrcData*.
473473

474-
[out] *szDest*
475-
Caller-allocated buffer to receive the decoded data.
474+
*szDest*<br/>
475+
[out] Caller-allocated buffer to receive the decoded data.
476476

477-
[out] *pnDestLen*
478-
Pointer to a variable that contains the length in bytes of *szDest*. If the function succeeds, the variable receives the number of bytes written to the buffer. If the function fails, the variable receives the required length in bytes of the buffer.
477+
*pnDestLen*<br/>
478+
[out] Pointer to a variable that contains the length in bytes of *szDest*. If the function succeeds, the variable receives the number of bytes written to the buffer. If the function fails, the variable receives the required length in bytes of the buffer.
479479

480-
[in] *dwFlags*
481-
ATLSMTP_QPENCODE flags describing how the conversion is to be performed.
480+
*dwFlags*<br/>
481+
[in] ATLSMTP_QPENCODE flags describing how the conversion is to be performed.
482482

483483
### Return Value
484484

‎docs/atl/reference/ccomgitptr-class.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -111,17 +111,17 @@ CComGITPtr(CComGITPtr&& rv);
111111

112112
### Parameters
113113

114-
[in] *p*
115-
An interface pointer to be stored in the global interface table (GIT).
114+
*p*<br/>
115+
[in] An interface pointer to be stored in the global interface table (GIT).
116116

117-
[in] *git*
118-
A reference to an existing `CComGITPtr` object.
117+
*git*<br/>
118+
[in] A reference to an existing `CComGITPtr` object.
119119

120-
[in] *dwCookie*
121-
A cookie used to identify the interface pointer.
120+
*dwCookie*<br/>
121+
[in] A cookie used to identify the interface pointer.
122122

123-
[in] *rv*
124-
The source `CComGITPtr` object to move data from.
123+
*rv*<br/>
124+
[in] The source `CComGITPtr` object to move data from.
125125

126126
### Remarks
127127

@@ -219,17 +219,17 @@ CComGITPtr& operator= (CComGITPtr&& rv);
219219

220220
### Parameters
221221

222-
[in] *p*
223-
A pointer to an interface.
222+
*p*<br/>
223+
[in] A pointer to an interface.
224224

225-
[in] *git*
226-
A reference to a `CComGITPtr` object.
225+
*git*<br/>
226+
[in] A reference to a `CComGITPtr` object.
227227

228-
[in] *dwCookie*
229-
A cookie used to identify the interface pointer.
228+
*dwCookie*<br/>
229+
[in] A cookie used to identify the interface pointer.
230230

231-
[in] *rv*
232-
The `CComGITPtr` to move data from.
231+
*rv*<br/>
232+
[in] The `CComGITPtr` to move data from.
233233

234234
### Return Value
235235

‎docs/atl/reference/idispatchimpl-class.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,23 +33,23 @@ class ATL_NO_VTABLE IDispatchImpl : public T
3333

3434
#### Parameters
3535

36-
[in] *T*
37-
A dual interface.
36+
*T*<br/>
37+
[in] A dual interface.
3838

39-
[in] *piid*
40-
A pointer to the IID of *T*.
39+
*piid*<br/>
40+
[in] A pointer to the IID of *T*.
4141

42-
[in] *plibid*
43-
A pointer to the LIBID of the type library that contains information about the interface. By default, the server-level type library is passed.
42+
*plibid*<br/>
43+
[in] A pointer to the LIBID of the type library that contains information about the interface. By default, the server-level type library is passed.
4444

45-
[in] *wMajor*
46-
The major version of the type library. By default, the value is 1.
45+
*wMajor*<br/>
46+
[in] The major version of the type library. By default, the value is 1.
4747

48-
[in] *wMinor*
49-
The minor version of the type library. By default, the value is 0.
48+
*wMinor*<br/>
49+
[in] The minor version of the type library. By default, the value is 0.
5050

51-
[in] *tihclass*
52-
The class used to manage the type information for *T*. By default, the value is `CComTypeInfoHolder`.
51+
*tihclass*<br/>
52+
[in] The class used to manage the type information for *T*. By default, the value is `CComTypeInfoHolder`.
5353

5454
## Members
5555

‎docs/atl/reference/iserviceproviderimpl-class.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,14 @@ STDMETHOD(QueryService)(
6969

7070
### Parameters
7171

72-
[IN] *guidService*
73-
Pointer to a service identifier (SID).
72+
*guidService*<br/>
73+
[in] Pointer to a service identifier (SID).
7474

75-
[IN] *riid*
76-
Identifier of the interface to which the caller is to gain access.
75+
*riid*<br/>
76+
[in] Identifier of the interface to which the caller is to gain access.
7777

78-
[OUT] *ppvObj*
79-
Indirect pointer to the requested interface.
78+
*ppvObj*<br/>
79+
[out] Indirect pointer to the requested interface.
8080

8181
### Return Value
8282

‎docs/atl/reference/registry-and-typelib-global-functions.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ ATLINLINE ATLAPI AtlGetPerUserRegistration(bool* pEnabled);
5656

5757
### Parameters
5858

59-
[out] *pEnabled*
60-
TRUE indicates that the registry information is directed to the **HKCU** node; FALSE indicates that the application writes registry information to the default node. The default node is **HKEY_CLASSES_ROOT** (**HKCR**).
59+
*pEnabled*<br/>
60+
[out] TRUE indicates that the registry information is directed to the **HKCU** node; FALSE indicates that the application writes registry information to the default node. The default node is **HKEY_CLASSES_ROOT** (**HKCR**).
6161

6262
### Return Value
6363

@@ -287,8 +287,8 @@ ATLINLINE ATLAPI AtlSetPerUserRegistration(bool bEnable);
287287

288288
### Parameters
289289

290-
[in] *bEnable*
291-
TRUE indicates that the registry information is directed to the **HKCU** node; FALSE indicates that the application writes registry information to the default node. The default node is **HKEY_CLASSES_ROOT** (**HKCR**).
290+
*bEnable*
291+
[in] TRUE indicates that the registry information is directed to the **HKCU** node; FALSE indicates that the application writes registry information to the default node. The default node is **HKEY_CLASSES_ROOT** (**HKCR**).
292292

293293
### Return Value
294294

‎docs/atl/reference/service-map-macros.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,14 @@ STDMETHOD(QueryService)(
110110

111111
### Parameters
112112

113-
[IN] *guidService*
114-
Pointer to a service identifier (SID).
113+
*guidService*<br/>
114+
[in] Pointer to a service identifier (SID).
115115

116-
[IN] *riid*
117-
Identifier of the interface to which the caller is to gain access.
116+
*riid*<br/>
117+
[in] Identifier of the interface to which the caller is to gain access.
118118

119-
[OUT] *ppvObj*
120-
Indirect pointer to the requested interface.
119+
*ppvObj*<br/>
120+
[out] Indirect pointer to the requested interface.
121121

122122
### Return Value
123123

‎docs/c-runtime-library/except-handler3.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,17 @@ int _except_handler3(
3030
```
3131

3232
#### Parameters
33-
[in] `exception_record`
34-
Information about the specific exception.
33+
`exception_record`<br/>
34+
[in] Information about the specific exception.
3535

36-
[in] `registration`
37-
The record that indicates which scope table should be used to find the exception handler.
36+
`registration`<br/>
37+
[in] The record that indicates which scope table should be used to find the exception handler.
3838

39-
[in] `context`
40-
Reserved.
39+
`context`<br/>
40+
[in] Reserved.
4141

42-
[in] `dispatcher`
43-
Reserved.
42+
`dispatcher`<br/>
43+
[in] Reserved.
4444

4545
## Return Value
4646
If an exception should be dismissed, returns `DISPOSITION_DISMISS`. If the exception should be passed up a level to the encapsulating exception handlers, returns `DISPOSITION_CONTINUE_SEARCH`.

‎docs/c-runtime-library/execute-onexit-table-initialize-onexit-table-register-onexit-function.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ int _execute_onexit_table(
3535
```
3636

3737
#### Parameters
38-
[inout] `table`
39-
Pointer to the onexit function table.
38+
`table`<br/>
39+
[inout] Pointer to the onexit function table.
4040

41-
[in] `function`
42-
Pointer to a function to add to the onexit function table.
41+
`function`<br/>
42+
[in] Pointer to a function to add to the onexit function table.
4343

4444
## Return Value
4545
If successful, returns 0. Otherwise, returns a negative value.

‎docs/c-runtime-library/local-unwind2.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ void _local_unwind2(
2828
```
2929

3030
#### Parameters
31-
[in] `xr`
32-
A registration record that is associated with one scope table.
31+
`xr`<br/>
32+
[in] A registration record that is associated with one scope table.
3333

34-
[in] `stop`
35-
The lexical level that indicates where `_local_unwind2` should stop.
34+
`stop`<br/>
35+
[in] The lexical level that indicates where `_local_unwind2` should stop.
3636

3737
## Remarks
3838
This method is used only by the run-time environment. Do not call the method in your code.

‎docs/c-runtime-library/lock.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ void __cdecl _lock
3030
```
3131

3232
#### Parameters
33-
[in] `locknum`
34-
The identifier of the lock to acquire.
33+
`locknum`<br/>
34+
[in] The identifier of the lock to acquire.
3535

3636
## Remarks
3737
If the lock has already been acquired, this method acquires the lock anyway and causes an internal C run-time (CRT) error. If the method cannot acquire a lock, it exits with a fatal error and sets the error code to `_RT_LOCK`.

0 commit comments

Comments
 (0)