Skip to content

Commit e95730c

Browse files
author
Colin Robertson
committed
A few more lints
1 parent bef743d commit e95730c

250 files changed

Lines changed: 2545 additions & 2544 deletions

File tree

Some content is hidden

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

docs/standard-library/algorithm-functions.md

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

docs/standard-library/allocator-base-class.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class allocator_base
7272
7373
**Namespace:** stdext
7474
75-
## <a name="charalloc"></a> allocator_base::_Charalloc
75+
## <a name="charalloc"></a> allocator_base::_Charalloc
7676
7777
Allocates storage for an array of type `char`.
7878
@@ -94,7 +94,7 @@ A pointer to the allocated object.
9494

9595
This member function is used by containers when compiled with a compiler that cannot compile rebind. It implements `_Charalloc` for the user-defined allocator by returning the result of a call to the `allocate` function of the synchronization filter.
9696

97-
## <a name="chardealloc"></a> allocator_base::_Chardealloc
97+
## <a name="chardealloc"></a> allocator_base::_Chardealloc
9898

9999
Frees storage for the array containing elements of type `char`.
100100

@@ -113,7 +113,7 @@ void _Chardealloc(void* ptr, size_type count);
113113
114114
This member function is used by containers when compiled with a compiler that cannot compile rebind. It implements `_Chardealloc` for the user-defined allocator by calling the `deallocate` function of the synchronization filter. The pointer ptr must have been earlier returned by a call to `_Charalloc` for an allocator object that compares equal to `*this`, allocating an array object of the same size and type. `_Chardealloc` never throws an exception.
115115
116-
## <a name="address"></a> allocator_base::address
116+
## <a name="address"></a> allocator_base::address
117117
118118
Finds the address of an object whose value is specified.
119119
@@ -136,7 +136,7 @@ A const or nonconst pointer to the object found of, respectively, const or nonco
136136

137137
This member function is implemented for the user-defined allocator by returning `&val`.
138138

139-
## <a name="allocate"></a> allocator_base::allocate
139+
## <a name="allocate"></a> allocator_base::allocate
140140

141141
Allocates a block of memory large enough to store at least some specified number of elements.
142142

@@ -162,7 +162,7 @@ A pointer to the allocated object.
162162
163163
The member function implements memory allocation for the user-defined allocator by returning the result of a call to the `allocate` function of the synchronization filter of type Type `*` if `_Nx == 1`, otherwise by returning the result of a call to `operator new(_Nx * sizeof(Type))` cast to type Type `*`.
164164
165-
## <a name="allocator_base"></a> allocator_base::allocator_base
165+
## <a name="allocator_base"></a> allocator_base::allocator_base
166166
167167
Constructs an object of type `allocator_base`.
168168
@@ -183,23 +183,23 @@ allocator_base(const allocator_base<Other, Sync>& right);
183183

184184
The first constructor constructs an [allocator_base](../standard-library/allocator-base-class.md) instance. The second constructor constructs an `allocator_base` instance such that for any `allocator_base<Type, _Sync>` instance `a`, `allocator_base<Type, Sync>(allocator_base<Other, Sync>(a)) == a`.
185185

186-
## <a name="const_pointer"></a> allocator_base::const_pointer
186+
## <a name="const_pointer"></a> allocator_base::const_pointer
187187

188188
A type that provides a constant pointer to the type of object managed by the allocator.
189189

190190
```cpp
191191
typedef const Type *const_pointer;
192192
```
193193

194-
## <a name="const_reference"></a> allocator_base::const_reference
194+
## <a name="const_reference"></a> allocator_base::const_reference
195195

196196
A type that provides a constant reference to type of object managed by the allocator.
197197

198198
```cpp
199199
typedef const Type& const_reference;
200200
```
201201

202-
## <a name="construct"></a> allocator_base::construct
202+
## <a name="construct"></a> allocator_base::construct
203203

204204
Constructs a specific type of object at a specified address that is initialized with a specified value.
205205

@@ -218,7 +218,7 @@ void construct(pointer ptr, const Type& val);
218218
219219
This member function is implemented for the user-defined allocator by calling `new((void*)ptr Type(val)`.
220220
221-
## <a name="deallocate"></a> allocator_base::deallocate
221+
## <a name="deallocate"></a> allocator_base::deallocate
222222
223223
Frees a specified number of objects from storage beginning at a specified position.
224224
@@ -237,7 +237,7 @@ void deallocate(pointer ptr, size_type _Nx);
237237

238238
This member function is implemented for the user-defined allocator by calling `deallocate(ptr)` on the synchronization filter `Sync` if `_Nx == 1`, otherwise by calling `operator delete(_Nx * ptr)`.
239239

240-
## <a name="destroy"></a> allocator_base::destroy
240+
## <a name="destroy"></a> allocator_base::destroy
241241

242242
Calls an objects destructor without deallocating the memory where the object was stored.
243243

@@ -255,15 +255,15 @@ void destroy(pointer ptr);
255255
256256
This member function is implemented for the user-defined allocator by calling `ptr->~Type()`.
257257
258-
## <a name="difference_type"></a> allocator_base::difference_type
258+
## <a name="difference_type"></a> allocator_base::difference_type
259259
260260
A signed integral type that can represent the difference between values of pointers to the type of object managed by the allocator.
261261
262262
```cpp
263263
typedef std::ptrdiff_t difference_type;
264264
```
265265

266-
## <a name="max_size"></a> allocator_base::max_size
266+
## <a name="max_size"></a> allocator_base::max_size
267267

268268
Returns the number of elements of type `Type` that could be allocated by an object of class allocator before the free memory is used up.
269269

@@ -279,31 +279,31 @@ The number of elements that could be allocated.
279279

280280
This member function is implemented for the user-defined allocator by returning `(size_t)-1 / sizeof(Type)` if `0 < (size_t)-1 / sizeof(Type)`, otherwise `1`.
281281

282-
## <a name="pointer"></a> allocator_base::pointer
282+
## <a name="pointer"></a> allocator_base::pointer
283283

284284
A type that provides a pointer to the type of object managed by the allocator.
285285

286286
```cpp
287287
typedef Type *pointer;
288288
```
289289

290-
## <a name="reference"></a> allocator_base::reference
290+
## <a name="reference"></a> allocator_base::reference
291291

292292
A type that provides a reference to the type of object managed by the allocator.
293293

294294
```cpp
295295
typedef Type& reference;
296296
```
297297

298-
## <a name="size_type"></a> allocator_base::size_type
298+
## <a name="size_type"></a> allocator_base::size_type
299299

300300
An unsigned integral type that can represent the length of any sequence that an object of template class `allocator_base` can allocate.
301301

302302
```cpp
303303
typedef std::size_t size_type;
304304
```
305305

306-
## <a name="value_type"></a> allocator_base::value_type
306+
## <a name="value_type"></a> allocator_base::value_type
307307

308308
A type that is managed by the allocator.
309309

docs/standard-library/allocator-class.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ These **Type**s specify the form that pointers and references must take for allo
9999
100100
**Namespace:** std
101101
102-
## <a name="address"></a> allocator::address
102+
## <a name="address"></a> allocator::address
103103
104104
Finds the address of an object whose value is specified.
105105
@@ -165,7 +165,7 @@ The original vector v1 is:
165165
The integer addressed by v1Ptr has a value of: *v1Ptr = 8.
166166
```
167167

168-
## <a name="allocate"></a> allocator::allocate
168+
## <a name="allocate"></a> allocator::allocate
169169

170170
Allocates a block of memory large enough to store at least some specified number of elements.
171171

@@ -225,7 +225,7 @@ int main( )
225225
0 1 2 3 4 5 6 7 8 9
226226
```
227227

228-
## <a name="allocator"></a> allocator::allocator
228+
## <a name="allocator"></a> allocator::allocator
229229

230230
Constructors used to create allocator objects.
231231

@@ -308,7 +308,7 @@ The allocator objects cv1Alloc & v1Alloc are equal.
308308
The allocator objects cAlloc & Alloc are equal.
309309
```
310310

311-
## <a name="const_pointer"></a> allocator::const_pointer
311+
## <a name="const_pointer"></a> allocator::const_pointer
312312

313313
A type that provides a constant pointer to the type of object managed by the allocator.
314314

@@ -363,7 +363,7 @@ The original vector v1 is:
363363
The integer's address found has a value of: 10.
364364
```
365365

366-
## <a name="const_reference"></a> allocator::const_reference
366+
## <a name="const_reference"></a> allocator::const_reference
367367

368368
A type that provides a constant reference to type of object managed by the allocator.
369369

@@ -429,7 +429,7 @@ The value of the element referred to by vcref,
429429
after nofication through its nonconst iterator, is: 175.
430430
```
431431

432-
## <a name="construct"></a> allocator::construct
432+
## <a name="construct"></a> allocator::construct
433433

434434
Constructs a specific type of object at a specified address that is initialized with a specified value.
435435

@@ -501,7 +501,7 @@ The modified vector v1 is:
501501
( 3 7 9 12 15 18 21 ).
502502
```
503503

504-
## <a name="deallocate"></a> allocator::deallocate
504+
## <a name="deallocate"></a> allocator::deallocate
505505

506506
Frees a specified number of objects from storage beginning at a specified position.
507507

@@ -525,7 +525,7 @@ The member function frees storage for the array of count objects of type **Type*
525525
526526
For an example using the member function, see [allocator::allocate](#allocate).
527527
528-
## <a name="destroy"></a> allocator::destroy
528+
## <a name="destroy"></a> allocator::destroy
529529
530530
Calls an objects destructor without deallocating the memory where the object was stored.
531531
@@ -591,7 +591,7 @@ The modified vector v1 is:
591591
( 2 4 6 8 10 -99 14 ).
592592
```
593593

594-
## <a name="difference_type"></a> allocator::difference_type
594+
## <a name="difference_type"></a> allocator::difference_type
595595

596596
A signed integral type that can represent the difference between values of pointers to the type of object managed by the allocator.
597597

@@ -652,7 +652,7 @@ Pointer v1PtrB addresses 12.
652652
The difference between the integer's addresses is: 8.
653653
```
654654

655-
## <a name="max_size"></a> allocator::max_size
655+
## <a name="max_size"></a> allocator::max_size
656656

657657
Returns the number of elements of type **Type** that could be allocated by an object of class allocator before the free memory is used up.
658658

@@ -721,7 +721,7 @@ int main( )
721721
}
722722
```
723723
724-
## <a name="op_eq"></a> allocator::operator=
724+
## <a name="op_eq"></a> allocator::operator=
725725
726726
Assigns one allocator object to another allocator object.
727727
@@ -784,7 +784,7 @@ int main( )
784784
}
785785
```
786786
787-
## <a name="pointer"></a> allocator::pointer
787+
## <a name="pointer"></a> allocator::pointer
788788
789789
A type that provides a pointer to the type of object managed by the allocator.
790790
@@ -839,7 +839,7 @@ The original vector v1 is:
839839
The integer addressed by v1Ptr has a value of: *v1Ptr = 12.
840840
```
841841

842-
## <a name="rebind"></a> allocator::rebind
842+
## <a name="rebind"></a> allocator::rebind
843843

844844
A structure that enables an allocator for objects of one type to allocate storage for objects of another type.
845845
```cpp
@@ -893,7 +893,7 @@ int main( )
893893
}
894894
```
895895
896-
## <a name="reference"></a> allocator::reference
896+
## <a name="reference"></a> allocator::reference
897897
898898
A type that provides a reference to the type of object managed by the allocator.
899899
@@ -953,7 +953,7 @@ The value of the element referred to by vref is: 100,
953953
The element referred to by vref after being modified is: 150.
954954
```
955955

956-
## <a name="size_type"></a> allocator::size_type
956+
## <a name="size_type"></a> allocator::size_type
957957

958958
An unsigned integral type that can represent the length of any sequence that an object of template class allocator can allocate.
959959

@@ -998,7 +998,7 @@ int main( )
998998
}
999999
```
10001000
1001-
## <a name="value_type"></a> allocator::value_type
1001+
## <a name="value_type"></a> allocator::value_type
10021002
10031003
A type that is managed by the allocator.
10041004

docs/standard-library/allocator-traits-class.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The following static methods call the corresponding method on a given allocator
6363

6464
**Namespace:** std
6565

66-
## <a name="allocate"></a> allocator_traits::allocate
66+
## <a name="allocate"></a> allocator_traits::allocate
6767

6868
Static method that allocates memory by using the given allocator parameter.
6969

@@ -93,7 +93,7 @@ The first static method returns `al.allocate(count)`.
9393
9494
The second method returns `al.allocate(count, hint)`, if that expression is well formed; otherwise it returns `al.allocate(count)`.
9595
96-
## <a name="construct"></a> allocator_traits::construct
96+
## <a name="construct"></a> allocator_traits::construct
9797
9898
Static method that uses a specified allocator to construct an object.
9999
@@ -117,7 +117,7 @@ static void construct(Alloc& al, Uty* ptr, Types&&... args);
117117

118118
The static member function calls `al.construct(ptr, args...)`, if that expression is well formed; otherwise it evaluates `::new (static_cast<void *>(ptr)) Uty(std::forward<Types>(args)...)`.
119119

120-
## <a name="deallocate"></a> allocator_traits::deallocate
120+
## <a name="deallocate"></a> allocator_traits::deallocate
121121

122122
Static method that uses a specified allocator to deallocate a specified number of objects.
123123

@@ -144,7 +144,7 @@ This method calls `al.deallocate(ptr, count)`.
144144
145145
This method throws nothing.
146146
147-
## <a name="destroy"></a> allocator_traits::destroy
147+
## <a name="destroy"></a> allocator_traits::destroy
148148
149149
Static method that uses a specified allocator to call the destructor on an object without deallocating its memory.
150150
@@ -165,7 +165,7 @@ static void destroy(Alloc& al, Uty* ptr);
165165

166166
This method calls `al.destroy(ptr)`, if that expression is well formed; otherwise it evaluates `ptr->~Uty()`.
167167

168-
## <a name="max_size"></a> allocator_traits::max_size
168+
## <a name="max_size"></a> allocator_traits::max_size
169169

170170
Static method that uses a specified allocator to determine the maximum number of objects that can be allocated.
171171

@@ -182,7 +182,7 @@ static size_type max_size(const Alloc& al);
182182
183183
This method returns `al.max_size()`, if that expression is well formed; otherwise it returns `numeric_limits<size_type>::max()`.
184184
185-
## <a name="select_on_container_copy_construction"></a> allocator_traits::select_on_container_copy_construction
185+
## <a name="select_on_container_copy_construction"></a> allocator_traits::select_on_container_copy_construction
186186
187187
Static method that calls `select_on_container_copy_construction` on the specified allocator.
188188

docs/standard-library/allocators-functions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ helpviewer_keywords: ["std::ALLOCATOR_DECL [C++]", "std::CACHE_CHUNKLIST [C++]",
1919
|[ALLOCATOR_DECL](#allocator_decl)|[CACHE_CHUNKLIST](#cache_chunklist)|[CACHE_FREELIST](#cache_freelist)|
2020
|[CACHE_SUBALLOC](#cache_suballoc)|[SYNC_DEFAULT](#sync_default)|
2121

22-
## <a name="allocator_decl"></a> ALLOCATOR_DECL
22+
## <a name="allocator_decl"></a> ALLOCATOR_DECL
2323

2424
Yields an allocator template class.
2525

@@ -59,7 +59,7 @@ public:
5959
};
6060
```
6161
62-
## <a name="cache_chunklist"></a> CACHE_CHUNKLIST
62+
## <a name="cache_chunklist"></a> CACHE_CHUNKLIST
6363
6464
Yields `stdext::allocators::cache_chunklist<sizeof(Type)>`.
6565
@@ -69,7 +69,7 @@ Yields `stdext::allocators::cache_chunklist<sizeof(Type)>`.
6969

7070
### Remarks
7171

72-
## <a name="cache_freelist"></a> CACHE_FREELIST
72+
## <a name="cache_freelist"></a> CACHE_FREELIST
7373

7474
Yields `stdext::allocators::cache_freelist<sizeof(Type), max>`.
7575

@@ -79,7 +79,7 @@ Yields `stdext::allocators::cache_freelist<sizeof(Type), max>`.
7979
8080
### Remarks
8181
82-
## <a name="cache_suballoc"></a> CACHE_SUBALLOC
82+
## <a name="cache_suballoc"></a> CACHE_SUBALLOC
8383
8484
Yields `stdext::allocators::cache_suballoc<sizeof(Type)>`.
8585
@@ -89,7 +89,7 @@ Yields `stdext::allocators::cache_suballoc<sizeof(Type)>`.
8989

9090
### Remarks
9191

92-
## <a name="sync_default"></a> SYNC_DEFAULT
92+
## <a name="sync_default"></a> SYNC_DEFAULT
9393

9494
Yields a synchronization filter.
9595

0 commit comments

Comments
 (0)