Skip to content

Commit c18d26d

Browse files
colin-homecolin-home
committed
Enhance tables in STL/CLI
1 parent 108c2d2 commit c18d26d

12 files changed

Lines changed: 662 additions & 662 deletions

‎docs/dotnet/adapter-stl-clr.md‎

Lines changed: 69 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ f1_keywords: ["<cliext/adapter>", "cliext::collection_adapter", "cliext::collect
77
helpviewer_keywords: ["<adapter> header [STL/CLR]", "adapter [STL/CLR]", "<cliext/adapter> header [STL/CLR]", "collection_adapter class [STL/CLR]", "base member [STL/CLR]", "begin member [STL/CLR]", "collection_adapter member [STL/CLR]", "difference_type member [STL/CLR]", "end member [STL/CLR]", "iterator member [STL/CLR]", "key_type member [STL/CLR]", "mapped_type member [STL/CLR]", "operator= member [STL/CLR]", "reference member [STL/CLR]", "size member [STL/CLR]", "size_type member [STL/CLR]", "swap member [STL/CLR]", "value_type member [STL/CLR]", "make_collection function [STL/CLR]", "range_adapter class [STL/CLR]", "operator= member [STL/CLR]", "range_adapter member [STL/CLR]"]
88
ms.assetid: 71ce7e51-42b6-4f70-9595-303791a97677
99
---
10-
# adapter (STL/CLR)
10+
# `<cliext/adapter>` (STL/CLR)
1111

1212
The STL/CLR header `<cliext/adapter>` specifies two class templates (`collection_adapter` and `range_adapter`), and the function template `make_collection`.
1313

@@ -25,18 +25,18 @@ The STL/CLR header `<cliext/adapter>` specifies two class templates (`collection
2525

2626
## Declarations
2727

28-
|Class|Description|
29-
|-----------|-----------------|
30-
|[collection_adapter (STL/CLR)](#collection_adapter)|Wraps the Base Class Library (BCL) collection as a range.|
31-
|[range_adapter (STL/CLR)](#range_adapter)|Wraps the range as a BCL collection.|
28+
| Class | Description |
29+
|---|---|
30+
| [`collection_adapter`](#collection_adapter) | Wraps the Base Class Library (BCL) collection as a range. |
31+
| [`range_adapter`](#range_adapter) | Wraps the range as a BCL collection. |
3232

33-
|Function|Description|
34-
|--------------|-----------------|
35-
|[make_collection (STL/CLR)](#make_collection)|Creates a range adapter using an iterator pair.|
33+
| Function | Description |
34+
|---|---|
35+
| [`make_collection`](#make_collection) | Creates a range adapter using an iterator pair. |
3636

3737
## Members
3838

39-
## <a name="collection_adapter"></a> collection_adapter (STL/CLR)
39+
## <a name="collection_adapter"></a> `collection_adapter`
4040

4141
Wraps a .NET collection for use as an STL/CLR container. A `collection_adapter` is a template class that describes a simple STL/CLR container object. It wraps a Base Class Library (BCL) interface, and returns an iterator pair that you use to manipulate the controlled sequence.
4242

@@ -80,47 +80,47 @@ The type of the wrapped collection.
8080
8181
### Specializations
8282
83-
|Specialization|Description|
84-
|--------------------|-----------------|
85-
|`IEnumerable`|Sequences through elements.|
86-
|`ICollection`|Maintains a group of elements.|
87-
|`IList`|Maintains an ordered group of elements.|
88-
|`IDictionary`|Maintain a set of {key, value} pairs.|
89-
|`IEnumerable<Value>`|Sequences through typed elements.|
90-
|`ICollection<Value>`|Maintains a group of typed elements.|
91-
|`IList<Value>`|Maintains an ordered group of typed elements.|
92-
|`IDictionary<Value>`|Maintains a set of typed {key, value} pairs.|
83+
| Specialization | Description |
84+
|---|---|
85+
| `IEnumerable` | Sequences through elements. |
86+
| `ICollection` | Maintains a group of elements. |
87+
| `IList` | Maintains an ordered group of elements. |
88+
| `IDictionary` | Maintain a set of {key, value} pairs. |
89+
| `IEnumerable<Value>` | Sequences through typed elements. |
90+
| `ICollection<Value>` | Maintains a group of typed elements. |
91+
| `IList<Value>` | Maintains an ordered group of typed elements. |
92+
| `IDictionary<Value>` | Maintains a set of typed {key, value} pairs. |
9393
9494
### Members
9595
96-
|Type Definition|Description|
97-
|---------------------|-----------------|
98-
|[collection_adapter::difference_type (STL/CLR)](#difference_type)|The type of a signed distance between two elements.|
99-
|[collection_adapter::iterator (STL/CLR)](#iterator)|The type of an iterator for the controlled sequence.|
100-
|[collection_adapter::key_type (STL/CLR)](#key_type)|The type of a dictionary key.|
101-
|[collection_adapter::mapped_type (STL/CLR)](#mapped_type)|The type of a dictionary value.|
102-
|[collection_adapter::reference (STL/CLR)](#reference)|The type of a reference to an element.|
103-
|[collection_adapter::size_type (STL/CLR)](#size_type)|The type of a signed distance between two elements.|
104-
|[collection_adapter::value_type (STL/CLR)](#value_type)|The type of an element.|
105-
106-
|Member Function|Description|
107-
|---------------------|-----------------|
108-
|[collection_adapter::base (STL/CLR)](#base)|Designates the wrapped BCL interface.|
109-
|[collection_adapter::begin (STL/CLR)](#begin)|Designates the beginning of the controlled sequence.|
110-
|[collection_adapter::collection_adapter (STL/CLR)](#collection_adapter_collection_adapter)|Constructs an adapter object.|
111-
|[collection_adapter::end (STL/CLR)](#end)|Designates the end of the controlled sequence.|
112-
|[collection_adapter::size (STL/CLR)](#size)|Counts the number of elements.|
113-
|[collection_adapter::swap (STL/CLR)](#swap)|Swaps the contents of two containers.|
114-
115-
|Operator|Description|
116-
|--------------|-----------------|
117-
|[collection_adapter::operator= (STL/CLR)](#op_eq)|Replaces the stored BCL handle.|
96+
| Type definition | Description |
97+
|---|---|
98+
| [`collection_adapter::difference_type`](#difference_type) | The type of a signed distance between two elements. |
99+
| [`collection_adapter::iterator`](#iterator) | The type of an iterator for the controlled sequence. |
100+
| [`collection_adapter::key_type`](#key_type) | The type of a dictionary key. |
101+
| [`collection_adapter::mapped_type`](#mapped_type) | The type of a dictionary value. |
102+
| [`collection_adapter::reference`](#reference) | The type of a reference to an element. |
103+
| [`collection_adapter::size_type`](#size_type) | The type of a signed distance between two elements. |
104+
| [`collection_adapter::value_type`](#value_type) | The type of an element. |
105+
106+
| Member function | Description |
107+
|---|---|
108+
| [`collection_adapter::base`](#base) | Designates the wrapped BCL interface. |
109+
| [`collection_adapter::begin`](#begin) | Designates the beginning of the controlled sequence. |
110+
| [`collection_adapter::collection_adapter`](#collection_adapter_collection_adapter) | Constructs an adapter object. |
111+
| [`collection_adapter::end`](#end) | Designates the end of the controlled sequence. |
112+
| [`collection_adapter::size`](#size) | Counts the number of elements. |
113+
| [`collection_adapter::swap`](#swap) | Swaps the contents of two containers. |
114+
115+
| Operator | Description |
116+
|---|---|
117+
| [`collection_adapter::operator=`](#op_eq) | Replaces the stored BCL handle. |
118118
119119
### Remarks
120120
121121
You use this template class to manipulate a BCL container as a STL/CLR container. The `collection_adapter` stores a handle to a BCL interface, which in turn controls a sequence of elements. A `collection_adapter` object `X` returns a pair of input iterators `X.begin()` and `X.end()` that you use to visit the elements, in order. Some of the specializations also let you write `X.size()` to determine the length of the controlled sequence.
122122
123-
## <a name="base"></a> collection_adapter::base (STL/CLR)
123+
## <a name="base"></a> `collection_adapter::base`
124124
125125
Designates the wrapped BCL interface.
126126
@@ -164,7 +164,7 @@ x x x x x x
164164
base() same = True
165165
```
166166

167-
## <a name="begin"></a> collection_adapter::begin (STL/CLR)
167+
## <a name="begin"></a> `collection_adapter::begin`
168168

169169
Designates the beginning of the controlled sequence.
170170

@@ -215,7 +215,7 @@ a b c
215215
*++begin() = b
216216
```
217217

218-
## <a name="collection_adapter_collection_adapter"></a> collection_adapter::collection_adapter (STL/CLR)
218+
## <a name="collection_adapter_collection_adapter"></a> `collection_adapter::collection_adapter`
219219

220220
Constructs an adapter object.
221221

@@ -309,7 +309,7 @@ x x x x x x
309309
x x x x x x
310310
```
311311

312-
## <a name="difference_type"></a> collection_adapter::difference_type (STL/CLR)
312+
## <a name="difference_type"></a> `collection_adapter::difference_type`
313313

314314
The types of a signed distance between two elements.
315315

@@ -361,7 +361,7 @@ a b c
361361
end()-begin() = 3
362362
```
363363

364-
## <a name="end"></a> collection_adapter::end (STL/CLR)
364+
## <a name="end"></a> `collection_adapter::end`
365365

366366
Designates the end of the controlled sequence.
367367

@@ -406,7 +406,7 @@ int main()
406406
a b c
407407
```
408408

409-
## <a name="iterator"></a> collection_adapter::iterator (STL/CLR)
409+
## <a name="iterator"></a> `collection_adapter::iterator`
410410

411411
The type of an iterator for the controlled sequence.
412412

@@ -451,7 +451,7 @@ int main()
451451
a b c
452452
```
453453

454-
## <a name="key_type"></a> collection_adapter::key_type (STL/CLR)
454+
## <a name="key_type"></a> `collection_adapter::key_type`
455455

456456
The type of a dictionary key.
457457

@@ -501,7 +501,7 @@ int main()
501501
[a 1] [b 2] [c 3]
502502
```
503503

504-
## <a name="mapped_type"></a> collection_adapter::mapped_type (STL/CLR)
504+
## <a name="mapped_type"></a> `collection_adapter::mapped_type`
505505

506506
The type of a dictionary value.
507507

@@ -551,7 +551,7 @@ int main()
551551
[a 1] [b 2] [c 3]
552552
```
553553

554-
## <a name="op_eq"></a> collection_adapter::operator= (STL/CLR)
554+
## <a name="op_eq"></a> `collection_adapter::operator=`
555555

556556
Replaces the stored BCL handle.
557557

@@ -608,7 +608,7 @@ a b c
608608
a b c
609609
```
610610

611-
## <a name="reference"></a> collection_adapter::reference (STL/CLR)
611+
## <a name="reference"></a> `collection_adapter::reference`
612612

613613
The type of a reference to an element.
614614

@@ -656,7 +656,7 @@ int main()
656656
a b c
657657
```
658658

659-
## <a name="size"></a> collection_adapter::size (STL/CLR)
659+
## <a name="size"></a> `collection_adapter::size`
660660

661661
Counts the number of elements.
662662

@@ -699,7 +699,7 @@ x x x x x x
699699
size() = 6
700700
```
701701

702-
## <a name="size_type"></a> collection_adapter::size_type (STL/CLR)
702+
## <a name="size_type"></a> `collection_adapter::size_type`
703703

704704
The type of a signed distance between two elements.
705705

@@ -744,7 +744,7 @@ x x x x x x
744744
size() = 6
745745
```
746746

747-
## <a name="swap"></a> collection_adapter::swap (STL/CLR)
747+
## <a name="swap"></a> `collection_adapter::swap`
748748

749749
Swaps the contents of two containers.
750750

@@ -813,7 +813,7 @@ x x x x x
813813
a b c
814814
```
815815

816-
## <a name="value_type"></a> collection_adapter::value_type (STL/CLR)
816+
## <a name="value_type"></a> `collection_adapter::value_type`
817817

818818
The type of an element.
819819

@@ -964,28 +964,28 @@ The type associated with the wrapped iterators.
964964
965965
### Members
966966
967-
|Member Function|Description|
968-
|---------------------|-----------------|
969-
|[range_adapter::range_adapter (STL/CLR)](#range_adapter_range_adapter)|Constructs an adapter object.|
967+
| Member function | Description |
968+
|---|---|
969+
| [`range_adapter::range_adapter`](#range_adapter_range_adapter) | Constructs an adapter object. |
970970
971-
|Operator|Description|
972-
|--------------|-----------------|
973-
|[range_adapter::operator= (STL/CLR)](#range_adapter_op_eq)|Replaces the stored iterator pair.|
971+
| Operator | Description |
972+
|---|---|
973+
| [`range_adapter::operator=`](#range_adapter_op_eq) | Replaces the stored iterator pair. |
974974
975975
### Interfaces
976976
977-
|Interface|Description|
978-
|---------------|-----------------|
979-
|<xref:System.Collections.IEnumerable>|Iterates through elements in the collection.|
980-
|<xref:System.Collections.ICollection>|Maintains a group of elements.|
981-
|<xref:System.Collections.Generic.IEnumerable%601>|Iterates through typed elements in the collection.|
982-
|<xref:System.Collections.Generic.ICollection%601>|Maintains a group of typed elements.|
977+
| Interface | Description |
978+
|---|---|
979+
| <xref:System.Collections.IEnumerable> | Iterates through elements in the collection. |
980+
| <xref:System.Collections.ICollection> | Maintains a group of elements. |
981+
| <xref:System.Collections.Generic.IEnumerable%601> | Iterates through typed elements in the collection. |
982+
| <xref:System.Collections.Generic.ICollection%601> | Maintains a group of typed elements. |
983983
984984
### Remarks
985985
986986
The range_adapter stores a pair of iterators, which in turn delimit a sequence of elements. The object implements four BCL interfaces that let you iterate through the elements, in order. You use this template class to manipulate STL/CLR ranges much like BCL containers.
987987
988-
## <a name="range_adapter_op_eq"></a> range_adapter::operator= (STL/CLR)
988+
## <a name="range_adapter_op_eq"></a> `range_adapter::operator=`
989989
990990
Replaces the stored iterator pair.
991991
@@ -1042,7 +1042,7 @@ a b c
10421042
a b c
10431043
```
10441044

1045-
## <a name="range_adapter_range_adapter"></a> range_adapter::range_adapter (STL/CLR)
1045+
## <a name="range_adapter_range_adapter"></a> `range_adapter::range_adapter`
10461046

10471047
Constructs an adapter object.
10481048

0 commit comments

Comments
 (0)