Skip to content

Commit 108c2d2

Browse files
committed
Fix style issues in STL/CLI
1 parent 26d7167 commit 108c2d2

14 files changed

Lines changed: 1717 additions & 1719 deletions

docs/dotnet/adapter-stl-clr.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The STL/CLR header `<cliext/adapter>` specifies two class templates (`collection
2121

2222
**Header:** \<cliext/adapter>
2323

24-
**Namespace:** cliext
24+
**Namespace:** `cliext`
2525

2626
## Declarations
2727

@@ -75,21 +75,21 @@ template<typename Key,
7575
7676
#### Parameters
7777
78-
*Coll*<br/>
78+
*`Coll`*\
7979
The type of the wrapped collection.
8080
8181
### Specializations
8282
8383
|Specialization|Description|
8484
|--------------------|-----------------|
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.|
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
@@ -230,10 +230,10 @@ collection_adapter(Coll^ collection);
230230
231231
#### Parameters
232232
233-
*collection*<br/>
233+
*`collection`*\
234234
BCL handle to wrap.
235235
236-
*right*<br/>
236+
*`right`*\
237237
Object to copy.
238238
239239
### Remarks
@@ -248,13 +248,13 @@ The constructor:
248248
249249
`collection_adapter(collection_adapter<Coll>% right);`
250250
251-
initializes the stored handle with `right.`[collection_adapter::base (STL/CLR)](#base)`()`.
251+
initializes the stored handle with `right.base()`.
252252
253253
The constructor:
254254
255255
`collection_adapter(collection_adapter<Coll>^ right);`
256256
257-
initializes the stored handle with `right->`[collection_adapter::base (STL/CLR)](#base)`()`.
257+
initializes the stored handle with `right->base()`.
258258
259259
The constructor:
260260
@@ -463,7 +463,7 @@ typedef Key key_type;
463463

464464
### Remarks
465465

466-
The type is a synonym for the template parameter `Key`, in a specialization for `IDictionary` or `IDictionary<Value>`; otherwise it is not defined.
466+
The type is a synonym for the template parameter `Key`, in a specialization for `IDictionary` or `IDictionary<Value>`; otherwise it isn't defined.
467467

468468
### Example
469469

@@ -513,7 +513,7 @@ typedef Value mapped_type;
513513

514514
### Remarks
515515

516-
The type is a synonym for the template parameter `Value`, in a specialization for `IDictionary` or `IDictionary<Value>`; otherwise it is not defined.
516+
The type is a synonym for the template parameter `Value`, in a specialization for `IDictionary` or `IDictionary<Value>`; otherwise it isn't defined.
517517

518518
### Example
519519

@@ -563,12 +563,12 @@ collection_adapter<Coll>% operator=(collection_adapter<Coll>% right);
563563

564564
#### Parameters
565565

566-
*right*<br/>
566+
*`right`*\
567567
Adapter to copy.
568568

569569
### Remarks
570570

571-
The member operator copies *right* to the object, then returns **`*this`**. You use it to replace the stored BCL handle with a copy of the stored BCL handle in *right*.
571+
The member operator copies *`right`* to the object, then returns **`*this`**. You use it to replace the stored BCL handle with a copy of the stored BCL handle in *`right`*.
572572

573573
### Example
574574

@@ -668,7 +668,7 @@ size_type size();
668668

669669
### Remarks
670670

671-
The member function returns the length of the controlled sequence. It is not defined in a specialization for `IEnumerable` or `IEnumerable<Value>`.
671+
The member function returns the length of the controlled sequence. It isn't defined in a specialization for `IEnumerable` or `IEnumerable<Value>`.
672672

673673
### Example
674674

@@ -701,7 +701,7 @@ size() = 6
701701

702702
## <a name="size_type"></a> collection_adapter::size_type (STL/CLR)
703703

704-
The type of a signed distance between two element.
704+
The type of a signed distance between two elements.
705705

706706
### Syntax
707707

@@ -756,12 +756,12 @@ void swap(collection_adapter<Coll>% right);
756756
757757
#### Parameters
758758
759-
*right*<br/>
759+
*`right`*\
760760
Container to swap contents with.
761761
762762
### Remarks
763763
764-
The member function swaps the stored BCL handles between **`*this`** and *right*.
764+
The member function swaps the stored BCL handles between **`*this`** and *`right`*.
765765
766766
### Example
767767
@@ -825,7 +825,7 @@ typedef Value value_type;
825825

826826
### Remarks
827827

828-
The type is a synonym for the template parameter *Value*, if present in the specialization; otherwise it is a synonym for `System::Object^`.
828+
The type is a synonym for the template parameter *`Value`*, if present in the specialization; otherwise it's a synonym for `System::Object^`.
829829

830830
### Example
831831

@@ -875,13 +875,13 @@ template<typename Iter>
875875
876876
#### Parameters
877877
878-
*Iter*<br/>
878+
*`Iter`*\
879879
The type of the wrapped iterators.
880880
881-
*first*<br/>
881+
*`first`*\
882882
First iterator to wrap.
883883
884-
*last*<br/>
884+
*`last`*\
885885
Second iterator to wrap.
886886
887887
### Remarks
@@ -942,7 +942,7 @@ SyncRoot not nullptr = True
942942

943943
## <a name="range_adapter"></a> range_adapter (STL/CLR)
944944

945-
A template class that wraps a pair of iterators that are used to implement several Base Class Library (BCL) interfaces. You use the range_adapter to manipulate an STL/CLR range as if it were a BCL collection.
945+
A template class that wraps a pair of iterators that are used to implement several Base Class Library (BCL) interfaces. You use the range_adapter to manipulate an STL/CLR range as if it was a BCL collection.
946946

947947
### Syntax
948948

@@ -959,7 +959,7 @@ template<typename Iter>
959959
960960
#### Parameters
961961
962-
*Iter*<br/>
962+
*`Iter`*\
963963
The type associated with the wrapped iterators.
964964
965965
### Members
@@ -978,7 +978,7 @@ The type associated with the wrapped iterators.
978978
|---------------|-----------------|
979979
|<xref:System.Collections.IEnumerable>|Iterates through elements in the collection.|
980980
|<xref:System.Collections.ICollection>|Maintains a group of elements.|
981-
|<xref:System.Collections.Generic.IEnumerable%601>|Iterates through typed elements in the collection..|
981+
|<xref:System.Collections.Generic.IEnumerable%601>|Iterates through typed elements in the collection.|
982982
|<xref:System.Collections.Generic.ICollection%601>|Maintains a group of typed elements.|
983983
984984
### Remarks
@@ -997,12 +997,12 @@ range_adapter<Iter>% operator=(range_adapter<Iter>% right);
997997

998998
#### Parameters
999999

1000-
*right*<br/>
1000+
*`right`*\
10011001
Adapter to copy.
10021002

10031003
### Remarks
10041004

1005-
The member operator copies *right* to the object, then returns **`*this`**. You use it to replace the stored iterator pair with a copy of the stored iterator pair in *right*.
1005+
The member operator copies *`right`* to the object, then returns **`*this`**. You use it to replace the stored iterator pair with a copy of the stored iterator pair in *`right`*.
10061006

10071007
### Example
10081008

@@ -1057,13 +1057,13 @@ range_adapter(Iter first, Iter last);
10571057
10581058
#### Parameters
10591059
1060-
*first*<br/>
1060+
*`first`*\
10611061
First iterator to wrap.
10621062
1063-
*last*<br/>
1063+
*`last`*\
10641064
Second iterator to wrap.
10651065
1066-
*right*<br/>
1066+
*`right`*\
10671067
Object to copy.
10681068
10691069
### Remarks
@@ -1078,7 +1078,7 @@ The constructor:
10781078
10791079
`range_adapter(range_adapter<Iter>% right);`
10801080
1081-
initializes the stored iterator pair by copying the pair stored in *right*.
1081+
initializes the stored iterator pair by copying the pair stored in *`right`*.
10821082
10831083
The constructor:
10841084
@@ -1090,7 +1090,7 @@ The constructor:
10901090
10911091
`range_adapter(Iter^ first, last);`
10921092
1093-
initializes the stored iterator pair with *first* and *last*.
1093+
initializes the stored iterator pair with *`first`* and *`last`*.
10941094
10951095
### Example
10961096

0 commit comments

Comments
 (0)