Skip to content

Commit 24c6fee

Browse files
author
mtx48109
committed
format mfc reference pr7
1 parent 6a1a57e commit 24c6fee

30 files changed

+1638
-1632
lines changed

docs/mfc/reference/clistctrl-class.md

Lines changed: 217 additions & 217 deletions
Large diffs are not rendered by default.

docs/mfc/reference/clistview-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ void RemoveImageList(int nImageList);
8888
```
8989

9090
### Parameters
91-
`nImageList`
91+
*nImageList*
9292
The zero-based index of the image to remove.
9393

9494
## See Also

docs/mfc/reference/cmap-class.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@ template<class KEY, class ARG_KEY, class VALUE, class ARG_VALUE>class CMap : pub
2222
```
2323

2424
#### Parameters
25-
`KEY`
25+
*KEY*
2626
Class of the object used as the key to the map.
2727

28-
`ARG_KEY`
29-
Data type used for `KEY` arguments; usually a reference to `KEY`.
28+
*ARG_KEY*
29+
Data type used for *KEY* arguments; usually a reference to *KEY*.
3030

31-
`VALUE`
31+
*VALUE*
3232
Class of the object stored in the map.
3333

34-
`ARG_VALUE`
35-
Data type used for `VALUE` arguments; usually a reference to `VALUE`.
34+
*ARG_VALUE*
35+
Data type used for *VALUE* arguments; usually a reference to *VALUE*.
3636

3737
## Members
3838

@@ -104,11 +104,11 @@ CMap(INT_PTR nBlockSize = 10);
104104
```
105105

106106
### Parameters
107-
`nBlockSize`
107+
*nBlockSize*
108108
Specifies the memory-allocation granularity for extending the map.
109109

110110
### Remarks
111-
As the map grows, memory is allocated in units of `nBlockSize` entries.
111+
As the map grows, memory is allocated in units of *nBlockSize* entries.
112112

113113
### Example
114114
[!code-cpp[NVC_MFCCollections#56](../../mfc/codesnippet/cpp/cmap-class_1.cpp)]
@@ -167,25 +167,25 @@ void GetNextAssoc(
167167
```
168168

169169
### Parameters
170-
`rNextPosition`
170+
*rNextPosition*
171171
Specifies a reference to a **POSITION** value returned by a previous `GetNextAssoc` or `GetStartPosition` call.
172172

173173
*KEY*
174174
Template parameter specifying the type of the map's key.
175175

176-
`rKey`
176+
*rKey*
177177
Specifies the returned key of the retrieved element.
178178

179179
*VALUE*
180180
Template parameter specifying the type of the map's value.
181181

182-
`rValue`
182+
*rValue*
183183
Specifies the returned value of the retrieved element.
184184

185185
### Remarks
186186
This function is most useful for iterating through all the elements in the map. Note that the position sequence is not necessarily the same as the key value sequence.
187187

188-
If the retrieved element is the last in the map, then the new value of `rNextPosition` is set to **NULL**.
188+
If the retrieved element is the last in the map, then the new value of *rNextPosition* is set to **NULL**.
189189

190190
### Example
191191
See the example for [CMap::SetAt](#setat).
@@ -230,10 +230,10 @@ void InitHashTable(UINT hashSize, BOOL bAllocNow = TRUE);
230230
```
231231

232232
### Parameters
233-
`hashSize`
233+
*hashSize*
234234
Number of entries in the hash table.
235235

236-
`bAllocNow`
236+
*bAllocNow*
237237
If **TRUE**, allocates the hash table upon initialization; otherwise the table is allocated when needed.
238238

239239
### Remarks
@@ -263,16 +263,16 @@ BOOL Lookup(ARG_KEY key, VALUE& rValue) const;
263263
```
264264

265265
### Parameters
266-
`ARG_KEY`
267-
Template parameter specifying the type of the `key` value.
266+
*ARG_KEY*
267+
Template parameter specifying the type of the *key* value.
268268

269-
`key`
269+
*key*
270270
Specifies the key that identifies the element to be looked up.
271271

272272
*VALUE*
273273
Specifies the type of the value to be looked up.
274274

275-
`rValue`
275+
*rValue*
276276
Receives the looked-up value.
277277

278278
### Return Value
@@ -295,10 +295,10 @@ VALUE& operator[](arg_key key);
295295
*VALUE*
296296
Template parameter specifying the type of the map value.
297297

298-
`ARG_KEY`
298+
*ARG_KEY*
299299
Template parameter specifying the type of the key value.
300300

301-
`key`
301+
*key*
302302
The key used to retrieve the value from the map.
303303

304304
### Remarks
@@ -327,7 +327,7 @@ CPair* PGetFirstAssoc();
327327
[!code-cpp[NVC_MFCCollections#59](../../mfc/codesnippet/cpp/cmap-class_4.cpp)]
328328

329329
## <a name="pgetnextassoc"></a> CMap::PGetNextAssoc
330-
Retrieves the map element pointed to by `pAssocRec`.
330+
Retrieves the map element pointed to by *pAssocRec*.
331331

332332
```
333333
const CPair *PGetNextAssoc(const CPair* pAssocRet) const;
@@ -357,7 +357,7 @@ CPair* PLookup(ARG_KEY key);
357357
```
358358

359359
### Parameters
360-
`key`
360+
*key*
361361
Key for the element to be searched for.
362362

363363
### Return Value
@@ -390,10 +390,10 @@ BOOL RemoveKey(ARG_KEY key);
390390
```
391391

392392
### Parameters
393-
`ARG_KEY`
393+
*ARG_KEY*
394394
Template parameter specifying the type of the key.
395395

396-
`key`
396+
*key*
397397
Key for the element to be removed.
398398

399399
### Return Value
@@ -413,16 +413,16 @@ void SetAt(ARG_KEY key, ARG_VALUE newValue);
413413
```
414414

415415
### Parameters
416-
`ARG_KEY`
417-
Template parameter specifying the type of the `key` parameter.
416+
*ARG_KEY*
417+
Template parameter specifying the type of the *key* parameter.
418418

419-
`key`
419+
*key*
420420
Specifies the key of the new element.
421421

422-
`ARG_VALUE`
423-
Template parameter specifying the type of the `newValue` parameter.
422+
*ARG_VALUE*
423+
Template parameter specifying the type of the *newValue* parameter.
424424

425-
`newValue`
425+
*newValue*
426426
Specifies the value of the new element.
427427

428428
### Remarks

docs/mfc/reference/cmapptrtoptr-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class CMapPtrToPtr : public CObject
2222
```
2323

2424
## Members
25-
The member functions of `CMapPtrToPtr` are similar to the member functions of class [CMapStringToOb](../../mfc/reference/cmapstringtoob-class.md). Because of this similarity, you can use the `CMapStringToOb` reference documentation for member function specifics. Wherever you see a `CObject` pointer as a function parameter or return value, substitute a pointer to `void`. Wherever you see a `CString` or a **const** pointer to `char` as a function parameter or return value, substitute a pointer to `void`.
25+
The member functions of `CMapPtrToPtr` are similar to the member functions of class [CMapStringToOb](../../mfc/reference/cmapstringtoob-class.md). Because of this similarity, you can use the `CMapStringToOb` reference documentation for member function specifics. Wherever you see a `CObject` pointer as a function parameter or return value, substitute a pointer to **void**. Wherever you see a `CString` or a **const** pointer to `char` as a function parameter or return value, substitute a pointer to **void**.
2626

2727
`BOOL CMapStringToOb::Lookup( const char* <key>,`
2828

docs/mfc/reference/cmapptrtoword-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class CMapPtrToWord : public CObject
2222
```
2323

2424
## Members
25-
The member functions of `CMapPtrToWord` are similar to the member functions of class [CMapStringToOb](../../mfc/reference/cmapstringtoob-class.md). Because of this similarity, you can use the `CMapStringToOb` reference documentation for member function specifics. Wherever you see a `CObject` pointer as a function parameter or return value, substitute **WORD**. Wherever you see a `CString` or a **const** pointer to `char` as a function parameter or return value, substitute a pointer to `void`.
25+
The member functions of `CMapPtrToWord` are similar to the member functions of class [CMapStringToOb](../../mfc/reference/cmapstringtoob-class.md). Because of this similarity, you can use the `CMapStringToOb` reference documentation for member function specifics. Wherever you see a `CObject` pointer as a function parameter or return value, substitute **WORD**. Wherever you see a `CString` or a **const** pointer to **char** as a function parameter or return value, substitute a pointer to **void**.
2626

2727
`BOOL CMapStringToOb::Lookup( const char* <key>,`
2828

docs/mfc/reference/cmapstringtoob-class.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -82,11 +82,11 @@ CMapStringToOb(INT_PTR nBlockSize = 10);
8282
```
8383

8484
### Parameters
85-
`nBlockSize`
85+
*nBlockSize*
8686
Specifies the memory-allocation granularity for extending the map.
8787

8888
### Remarks
89-
As the map grows, memory is allocated in units of `nBlockSize` entries.
89+
As the map grows, memory is allocated in units of *nBlockSize* entries.
9090

9191
The following table shows other member functions that are similar to **CMapStringToOb:: CMapStringToOb**.
9292

@@ -272,7 +272,7 @@ UINT HashKey(LPCTSTR key) const;
272272
```
273273

274274
### Parameters
275-
`key`
275+
*key*
276276
The key whose hash value is to be calculated.
277277

278278
### Return Value
@@ -300,10 +300,10 @@ void InitHashTable(
300300
```
301301

302302
### Parameters
303-
`hashSize`
303+
*hashSize*
304304
Number of entries in the hash table.
305305

306-
`bAllocNow`
306+
*bAllocNow*
307307
If **TRUE**, allocates the hash table upon initialization; otherwise the table is allocated when needed.
308308

309309
### Remarks
@@ -355,10 +355,10 @@ BOOL Lookup(
355355
```
356356

357357
### Parameters
358-
`key`
358+
*key*
359359
Specifies the string key that identifies the element to be looked up.
360360

361-
`rValue`
361+
*rValue*
362362
Specifies the returned value from the looked-up element.
363363

364364
### Return Value
@@ -393,10 +393,10 @@ BOOL LookupKey(
393393
```
394394

395395
### Parameters
396-
`key`
396+
*key*
397397
Specifies the string key that identifies the element to be looked up.
398398

399-
`rKey`
399+
*rKey*
400400
The reference to the associated key.
401401

402402
### Return Value
@@ -420,7 +420,7 @@ CObject*& operator[ ](lpctstr key);
420420
```
421421

422422
### Return Value
423-
A reference to a pointer to a `CObject` object; or **NULL** if the map is empty or `key` is out of range.
423+
A reference to a pointer to a `CObject` object; or **NULL** if the map is empty or *key* is out of range.
424424

425425
### Remarks
426426
Thus it can be used only on the left side of an assignment statement (an l-value). If there is no map element with the specified key, then a new element is created.
@@ -487,7 +487,7 @@ BOOL RemoveKey(LPCTSTR key);
487487
```
488488

489489
### Parameters
490-
`key`
490+
*key*
491491
Specifies the string used for map lookup.
492492

493493
### Return Value
@@ -532,10 +532,10 @@ void SetAt(
532532
```
533533

534534
### Parameters
535-
`key`
535+
*key*
536536
Specifies the string that is the key of the new element.
537537

538-
`newValue`
538+
*newValue*
539539
Specifies the `CObject` pointer that is the value of the new element.
540540

541541
### Remarks

docs/mfc/reference/cmapstringtoptr-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class CMapStringToPtr : public CObject
2222
```
2323

2424
## Members
25-
The member functions of `CMapStringToPtr` are similar to the member functions of class [CMapStringToOb](../../mfc/reference/cmapstringtoob-class.md). Because of this similarity, you can use the `CMapStringToOb` reference documentation for member function specifics. Wherever you see a `CObject` pointer as a function parameter or return value, substitute a pointer to `void`.
25+
The member functions of `CMapStringToPtr` are similar to the member functions of class [CMapStringToOb](../../mfc/reference/cmapstringtoob-class.md). Because of this similarity, you can use the `CMapStringToOb` reference documentation for member function specifics. Wherever you see a `CObject` pointer as a function parameter or return value, substitute a pointer to **void**.
2626

2727
`BOOL CMapStringToOb::Lookup( const char* <key>,`
2828

0 commit comments

Comments
 (0)