Skip to content

Commit 9c72b08

Browse files
author
Colin Robertson
authored
Merge pull request #751 from corob-msft/cr-space-break-2
Add atomic_structure.md content
2 parents 4030340 + 938e962 commit 9c72b08

File tree

145 files changed

+1227
-770
lines changed

Some content is hidden

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

145 files changed

+1227
-770
lines changed

docs/standard-library/algorithm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ C++ Standard Library algorithms are often classified into groups that indicate s
4343

4444
The C++ Standard Library numeric algorithms that are provided for numerical processing have their own header file [\<numeric>](../standard-library/numeric.md), and function objects and adaptors are defined in the header [\<functional>](../standard-library/functional.md) Function objects that return Boolean values are known as predicates. The default binary predicate is the comparison `operator<`. In general, the elements being ordered need to be less than comparable so that, given any two elements, it can be determined either that they are equivalent (in the sense that neither is less than the other) or that one is less than the other. This results in an ordering among the nonequivalent elements.
4545

46-
### Functions
46+
### Function templates
4747

48-
|||
48+
|Function template|Description|
4949
|-|-|
5050
|[adjacent_find](../standard-library/algorithm-functions.md#adjacent_find)|Searches for two adjacent elements that are either equal or satisfy a specified condition.|
5151
|[all_of](../standard-library/algorithm-functions.md#all_of)|Returns `true` when a condition is present at each element in the given range.|

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@ class allocator_base
3737
3838
### Constructors
3939
40-
|||
40+
|Constructor|Description|
4141
|-|-|
4242
|[allocator_base](#allocator_base)|Constructs an object of type `allocator_base`.|
4343
44-
### TypeDefs
44+
### Typedefs
4545
46-
|||
46+
|Type name|Description|
4747
|-|-|
4848
|[const_pointer](#const_pointer)|A type that provides a constant pointer to the type of object managed by the allocator.|
4949
|[const_reference](#const_reference)|A type that provides a constant reference to type of object managed by the allocator.|
@@ -53,9 +53,9 @@ class allocator_base
5353
|[size_type](#size_type)|An unsigned integral type that can represent the length of any sequence that an object of template class `allocator_base` can allocate.|
5454
|[value_type](#value_type)|A type that is managed by the allocator.|
5555
56-
### Member Functions
56+
### Member functions
5757
58-
|||
58+
|Member function|Description|
5959
|-|-|
6060
|[_Charalloc](#charalloc)|Allocates storage for an array of type `char`.|
6161
|[_Chardealloc](#chardealloc)|Frees storage for the array containing elements of type `char`.|

docs/standard-library/allocator-class.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ These **Type**s specify the form that pointers and references must take for allo
5959
6060
### Constructors
6161
62-
|||
62+
|Constructor|Description|
6363
|-|-|
6464
|[allocator](#allocator)|Constructors used to create `allocator` objects.|
6565
6666
### Typedefs
6767
68-
|||
68+
|Type name|Description|
6969
|-|-|
7070
|[const_pointer](#const_pointer)|A type that provides a constant pointer to the type of object managed by the allocator.|
7171
|[const_reference](#const_reference)|A type that provides a constant reference to type of object managed by the allocator.|
@@ -75,9 +75,9 @@ These **Type**s specify the form that pointers and references must take for allo
7575
|[size_type](#size_type)|An unsigned integral type that can represent the length of any sequence that an object of template class `allocator` can allocate.|
7676
|[value_type](#value_type)|A type that is managed by the allocator.|
7777
78-
### Member Functions
78+
### Member functions
7979
80-
|||
80+
|Member function|Description|
8181
|-|-|
8282
|[address](#address)|Finds the address of an object whose value is specified.|
8383
|[allocate](#allocate)|Allocates a block of memory large enough to store at least some specified number of elements.|
@@ -89,7 +89,7 @@ These **Type**s specify the form that pointers and references must take for allo
8989
9090
### Operators
9191
92-
|||
92+
|Operator|Description|
9393
|-|-|
9494
|[operator=](#op_eq)|Assigns one `allocator` object to another `allocator` object.|
9595

docs/standard-library/allocators-header.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ The cache template `cache_freelist` takes a max class argument which determines
123123

124124
### Macros
125125

126-
|||
126+
|Macro|Description|
127127
|-|-|
128128
|[ALLOCATOR_DECL](../standard-library/allocators-functions.md#allocator_decl)|Yields an allocator template class.|
129129
|[CACHE_CHUNKLIST](../standard-library/allocators-functions.md#cache_chunklist)|Yields `stdext::allocators::cache_chunklist<sizeof(Type)>`.|
@@ -133,14 +133,14 @@ The cache template `cache_freelist` takes a max class argument which determines
133133

134134
### Operators
135135

136-
|||
136+
|Operator|Description|
137137
|-|-|
138138
|[operator!= (\<allocators>)](../standard-library/allocators-operators.md#op_neq)|Tests for inequality between allocator objects of a specified class.|
139139
|[operator== (\<allocators>)](../standard-library/allocators-operators.md#op_eq_eq)|Tests for equality between allocator objects of a specified class.|
140140

141141
### Classes
142142

143-
|||
143+
|Class|Description|
144144
|-|-|
145145
|[allocator_base](../standard-library/allocator-base-class.md)|Defines the base class and common functions needed to create a user-defined allocator from a synchronization filter.|
146146
|[allocator_chunklist](../standard-library/allocator-chunklist-class.md)|Describes an object that manages storage allocation and freeing for objects using a cache of type [cache_chunklist](../standard-library/cache-chunklist-class.md).|

docs/standard-library/array-class-stl.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,15 @@ class array;
3030
3131
### Parameters
3232
33-
|||
34-
|-|-|
3533
|Parameter|Description|
34+
|-|-|
3635
|`Ty`|The type of an element.|
3736
|`N`|The number of elements.|
3837
3938
## Members
4039
41-
|||
42-
|-|-|
4340
|Type Definition|Description|
41+
|-|-|
4442
|[const_iterator](#const_iterator)|The type of a constant iterator for the controlled sequence.|
4543
|[const_pointer](#const_pointer)|The type of a constant pointer to an element.|
4644
|[const_reference](#const_reference)|The type of a constant reference to an element.|
@@ -53,9 +51,8 @@ class array;
5351
|[size_type](#size_type)|The type of an unsigned distance between two elements.|
5452
|[value_type](#value_type)|The type of an element.|
5553
56-
|||
57-
|-|-|
5854
|Member Function|Description|
55+
|-|-|
5956
|[array](#array)|Constructs an array object.|
6057
|[assign](#assign)|Replaces all elements.|
6158
|[at](#at)|Accesses an element at a specified position.|
@@ -76,9 +73,8 @@ class array;
7673
|[size](#size)|Counts the number of elements.|
7774
|[swap](#swap)|Swaps the contents of two containers.|
7875
79-
|||
80-
|-|-|
8176
|Operator|Description|
77+
|-|-|
8278
|[array::operator=](#op_eq)|Replaces the controlled sequence.|
8379
|[array::operator[]](#op_at)|Accesses an element at a specified position.|
8480
@@ -892,9 +888,8 @@ void fill(const Type& val);
892888
893889
### Parameters
894890
895-
|||
896-
|-|-|
897891
|Parameter|Description|
892+
|-|-|
898893
|`val`|The value of the element being inserted into the array.|
899894
900895
### Remarks

docs/standard-library/array.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ Defines the container template class `array` and several supporting templates.
2929

3030
### Classes
3131

32-
|||
32+
|Class|Description|
3333
|-|-|
3434
|[array](../standard-library/array-class-stl.md)|Stores a fixed-length sequence of elements.|
3535
|[tuple_element](../standard-library/tuple-element-class-tuple.md)|Wraps the type of an array element.|
3636
|[tuple_size](../standard-library/tuple-size-class-tuple.md)|Wraps the size of an array element.|
3737

3838
### Operators
3939

40-
|||
40+
|Operator|Description|
4141
|-|-|
4242
|[operator==](../standard-library/array-operators.md#op_eq_eq)|array comparison, equal|
4343
|[operator!=](../standard-library/array-operators.md#op_neq)|array comparison, not equal|
@@ -48,7 +48,7 @@ Defines the container template class `array` and several supporting templates.
4848

4949
### Functions
5050

51-
|||
51+
|Function|Description|
5252
|-|-|
5353
|[get](../standard-library/array-functions.md#get)|Get specified array element.|
5454
|[swap](../standard-library/array-functions.md#swap)|Exchanges the contents of one array with the contents of another array.|

docs/standard-library/atomic-enums.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ typedef enum memory_order {
2929
} memory_order;
3030
```
3131

32-
### Remarks
32+
### Enumeration members
3333

3434
|||
3535
|-|-|

0 commit comments

Comments
 (0)