Skip to content

Commit fc190fe

Browse files
authored
removed the class name qualifier from member headings and table entries in concrt and amp (MicrosoftDocs#124)
* fixed syntax blocks with IUIAnimationTransitionFactory pointers * more code block fixes in mfc * fixes in atl syntax blocks * more atl syntax fixes * syntax formatting in atl-mfc-shared * manual formatting tweaks in mfc-atl-shared and atl * removed code reference to non-existing snippet * fixes to broken tables in concrt and amp * cleaned up headings in amp and concrt per mvp feedback * remvoed type qualification from headings and table entries
1 parent 8f7488f commit fc190fe

File tree

123 files changed

+2446
-1713
lines changed

Some content is hidden

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

123 files changed

+2446
-1713
lines changed

docs/parallel/amp/reference/accelerator-class.md

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

docs/parallel/amp/reference/accelerator-view-class.md

Lines changed: 53 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -49,39 +49,39 @@ class accelerator_view;
4949

5050
|Name|Description|
5151
|----------|-----------------|
52-
|[accelerator_view::accelerator_view Constructor](#ctor)|Initializes a new instance of the `accelerator_view` class.|
53-
|[accelerator_view::~accelerator_view Destructor](#dtor)|Destroys the `accelerator_view` object.|
52+
|[accelerator_view Constructor](#ctor)|Initializes a new instance of the `accelerator_view` class.|
53+
|[~accelerator_view Destructor](#dtor)|Destroys the `accelerator_view` object.|
5454

5555
### Public Methods
5656

5757
|Name|Description|
5858
|----------|-----------------|
59-
|[accelerator_view::create_marker Method](#create_marker)|Returns a future to track the completion of all commands submitted so far to this `accelerator_view` object.|
60-
|[accelerator_view::flush Method](#flush)|Submits all pending commands queued to the `accelerator_view` object to the accelerator for execution.|
61-
|[accelerator_view::get_accelerator Method](#get_accelerator)|Returns the `accelerator` object for the `accelerator_view` object.|
62-
|[accelerator_view::get_is_auto_selection Method](#get_is_auto_selection)|Returns a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the `accelerator_view` object is passed to a [parallel_for_each](concurrency-namespace-functions-amp.md#parallel_for_each).|
63-
|[accelerator_view::get_is_debug Method](#get_is_debug)|Returns a Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting.|
64-
|[accelerator_view::get_queuing_mode Method](#get_queuing_mode)|Returns the queuing mode for the `accelerator_view` object.|
65-
|[accelerator_view::get_version Method](#get_version)|Returns the version of the `accelerator_view`.|
66-
|[accelerator_view::wait Method](#wait)|Waits for all commands submitted to the `accelerator_view` object to finish.|
59+
|[create_marker Method](#create_marker)|Returns a future to track the completion of all commands submitted so far to this `accelerator_view` object.|
60+
|[flush Method](#flush)|Submits all pending commands queued to the `accelerator_view` object to the accelerator for execution.|
61+
|[get_accelerator Method](#get_accelerator)|Returns the `accelerator` object for the `accelerator_view` object.|
62+
|[get_is_auto_selection Method](#get_is_auto_selection)|Returns a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the `accelerator_view` object is passed to a [parallel_for_each](concurrency-namespace-functions-amp.md#parallel_for_each).|
63+
|[get_is_debug Method](#get_is_debug)|Returns a Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting.|
64+
|[get_queuing_mode Method](#get_queuing_mode)|Returns the queuing mode for the `accelerator_view` object.|
65+
|[get_version Method](#get_version)|Returns the version of the `accelerator_view`.|
66+
|[wait Method](#wait)|Waits for all commands submitted to the `accelerator_view` object to finish.|
6767

6868
### Public Operators
6969

7070
|Name|Description|
7171
|----------|-----------------|
72-
|[accelerator_view::operator!= Operator](#operator_neq)|Compares this `accelerator_view` object with another and returns `false` if they are the same; otherwise, returns `true`.|
73-
|[accelerator_view::operator= Operator](#operator_eq)|Copies the contents of the specified `accelerator_view` object into this one.|
74-
|[accelerator_view::operator== Operator](#operator_eq_eq)|Compares this `accelerator_view` object with another and returns `true` if they are the same; otherwise, returns `false`.|
72+
|[operator!= Operator](#operator_neq)|Compares this `accelerator_view` object with another and returns `false` if they are the same; otherwise, returns `true`.|
73+
|[operator= Operator](#operator_eq)|Copies the contents of the specified `accelerator_view` object into this one.|
74+
|[operator== Operator](#operator_eq_eq)|Compares this `accelerator_view` object with another and returns `true` if they are the same; otherwise, returns `false`.|
7575

7676
### Public Data Members
7777

7878
|Name|Description|
7979
|----------|-----------------|
80-
|[accelerator_view::accelerator Data Member](#accelerator)|Gets the `accelerator` object for the `accelerator_view` object.|
81-
|[accelerator_view::is_auto_selection Data Member](#is_auto_selection)|Gets a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the `accelerator_view` object is passed to a [parallel_for_each](concurrency-namespace-functions-amp.md#parallel_for_each).|
82-
|[accelerator_view::is_debug Data Member](#is_debug)|Gets a Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting.|
83-
|[accelerator_view::queuing_mode Data Member](#queuing_mode)|Gets the queuing mode for the `accelerator_view` object.|
84-
|[accelerator_view::version Data Member](#version)|Gets the version of the accelerator.|
80+
|[accelerator Data Member](#accelerator)|Gets the `accelerator` object for the `accelerator_view` object.|
81+
|[is_auto_selection Data Member](#is_auto_selection)|Gets a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the `accelerator_view` object is passed to a [parallel_for_each](concurrency-namespace-functions-amp.md#parallel_for_each).|
82+
|[is_debug Data Member](#is_debug)|Gets a Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting.|
83+
|[queuing_mode Data Member](#queuing_mode)|Gets the queuing mode for the `accelerator_view` object.|
84+
|[version Data Member](#version)|Gets the version of the accelerator.|
8585

8686
## Inheritance Hierarchy
8787
`accelerator_view`
@@ -98,7 +98,7 @@ class accelerator_view;
9898

9999
**Namespace:** Concurrency
100100

101-
## <a name="accelerator"></a> accelerator_view::accelerator Data Member
101+
## <a name="accelerator"></a> accelerator
102102

103103
Gets the accelerator object for the accelerator_view object.
104104

@@ -108,7 +108,8 @@ Gets the accelerator object for the accelerator_view object.
108108
__declspec(property(get= get_accelerator)) Concurrency::accelerator accelerator;
109109
```
110110

111-
## <a name="ctor"></a> accelerator_view::accelerator_view Constructor
111+
## <a name="ctor"></a> accelerator_view
112+
112113
Initializes a new instance of the accelerator_view class by copying an existing `accelerator_view` object.
113114

114115
### Syntax
@@ -121,7 +122,8 @@ accelerator_view( const accelerator_view & _Other );
121122
`_Other`
122123
The `accelerator_view` object to copy.
123124

124-
## <a name="accelerator_view__create_marker"></a> accelerator_view::create_marker Method
125+
## <a name="accelerator_view__create_marker"></a> create_marker
126+
125127
Returns a future to track the completion of all commands submitted so far to this `accelerator_view` object.
126128

127129
### Syntax
@@ -133,7 +135,8 @@ concurrency::completion_future create_marker();
133135
### Return Value
134136
A future to track the completion of all commands submitted so far to this `accelerator_view` object.
135137

136-
## <a name="flush"></a> accelerator_view::flush Method
138+
## <a name="flush"></a> flush
139+
137140
Submits all pending commands queued to the accelerator_view object to the accelerator for execution.
138141

139142
### Syntax
@@ -145,7 +148,8 @@ void flush();
145148
### Return Value
146149
Returns `void`.
147150

148-
## <a name="accelerator_view__get_accelerator"></a> accelerator_view::get_accelerator Method
151+
## <a name="accelerator_view__get_accelerator"></a> get_accelerator
152+
149153
Returns the accelerator object for the accelerator_view object.
150154
### Syntax
151155
```
@@ -154,7 +158,8 @@ accelerator get_accelerator() const;
154158
### Return Value
155159
The accelerator object for the accelerator_view object.
156160

157-
## <a name="accelerator_view__get_is_auto_selection"></a> accelerator_view::get_is_auto_selection Method
161+
## <a name="accelerator_view__get_is_auto_selection"></a> get_is_auto_selection
162+
158163
Returns a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the accelerator_view is passed to a [parallel_for_each](concurrency-namespace-functions-amp.md#parallel_for_each).
159164

160165
### Syntax
@@ -166,7 +171,8 @@ bool get_is_auto_selection() const;
166171
### Return Value
167172
`true` if the runtime will automatically select an appropriate accelerator; otherwise, `false`.
168173

169-
## <a name="accelerator_view__get_is_debug"></a> accelerator_view::get_is_debug Method
174+
## <a name="accelerator_view__get_is_debug"></a> get_is_debug
175+
170176
Returns a Boolean value that indicates whether the accelerator_view object has the DEBUG layer enabled for extensive error reporting.
171177

172178
### Syntax
@@ -178,7 +184,8 @@ bool get_is_debug() const;
178184
### Return Value
179185
A Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting.
180186

181-
## <a name="accelerator_view__get_queuing_mode"></a> accelerator_view::get_queuing_mode Method
187+
## <a name="accelerator_view__get_queuing_mode"></a> get_queuing_mode
188+
182189
Returns the queuing mode for the accelerator_view object.
183190

184191
### Syntax
@@ -190,7 +197,8 @@ queuing_mode get_queuing_mode() const;
190197
### Return Value
191198
The queuing mode for the `accelerator_view` object.
192199

193-
## <a name="accelerator_view__get_version"></a> accelerator_view::get_version Method
200+
## <a name="accelerator_view__get_version"></a> get_version
201+
194202
Returns the version of the accelerator_view.
195203

196204
### Syntax
@@ -202,7 +210,8 @@ unsigned int get_version() const;
202210
### Return Value
203211
The version of the `accelerator_view`.
204212

205-
## <a name="accelerator_view__is_auto_selection"></a> accelerator_view::is_auto_selection Data Member
213+
## <a name="accelerator_view__is_auto_selection"></a> is_auto_selection
214+
206215
Gets a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the accelerator_view is passed to a [parallel_for_each](concurrency-namespace-functions-amp.md#parallel_for_each).
207216

208217
### Syntax
@@ -211,7 +220,8 @@ Gets a Boolean value that indicates whether the runtime will automatically selec
211220
__declspec(property(get= get_is_auto_selection)) bool is_auto_selection;
212221
```
213222

214-
## <a name="accelerator_view__is_debug"></a> accelerator_view::is_debug Data Member
223+
## <a name="accelerator_view__is_debug"></a> is_debug
224+
215225
Gets a Boolean value that indicates whether the accelerator_view object has the DEBUG layer enabled for extensive error reporting.
216226

217227
### Syntax
@@ -220,7 +230,8 @@ Gets a Boolean value that indicates whether the accelerator_view object has the
220230
__declspec(property(get= get_is_debug)) bool is_debug;
221231
```
222232

223-
## <a name="accelerator_view__operator_neq"></a> accelerator_view::operator!= Operator
233+
## <a name="accelerator_view__operator_neq"></a> operator!=
234+
224235
Compares this accelerator_view object with another and returns `false` if they are the same; otherwise, returns `true`.
225236

226237
### Syntax
@@ -236,7 +247,8 @@ bool operator!= ( const accelerator_view & _Other ) const;
236247
### Return Value
237248
`false` if the two objects are the same; otherwise, `true`.
238249

239-
## <a name="accelerator_view__operator_eq"></a> accelerator_view::operator= Operator
250+
## <a name="accelerator_view__operator_eq"></a> operator=
251+
240252
Copies the contents of the specified accelerator_view object into this one.
241253

242254
### Syntax
@@ -252,7 +264,8 @@ accelerator_view & operator= ( const accelerator_view & _Other );
252264
### Return Value
253265
A reference to the modified `accelerator_view` object.
254266

255-
## <a name="accelerator_view__operator_eq_eq"></a> accelerator_view::operator== Operator
267+
## <a name="accelerator_view__operator_eq_eq"></a> operator==
268+
256269
Compares this accelerator_view object with another and returns `true` if they are the same; otherwise, returns `false`.
257270

258271
### Syntax
@@ -268,7 +281,8 @@ bool operator= = ( const accelerator_view & _Other ) const;
268281
### Return Value
269282
`true` if the two objects are the same; otherwise, `false`.
270283

271-
## <a name="accelerator_view__queuing_mode"></a> accelerator_view::queuing_mode Data Member
284+
## <a name="accelerator_view__queuing_mode"></a> queuing_mode
285+
272286
Gets the queuing mode for the accelerator_view object.
273287

274288
### Syntax
@@ -277,7 +291,8 @@ Gets the queuing mode for the accelerator_view object.
277291
__declspec(property(get= get_queuing_mode)) Concurrency::queuing_mode queuing_mode;
278292
```
279293

280-
## <a name="accelerator_view__version"></a> accelerator_view::version Data Member
294+
## <a name="accelerator_view__version"></a> version
295+
281296
Gets the version of the accelerator_view.
282297

283298
### Syntax
@@ -286,7 +301,8 @@ Gets the version of the accelerator_view.
286301
__declspec(property(get= get_version)) unsigned int version;
287302
```
288303

289-
## <a name="accelerator_view__wait"></a> accelerator_view::wait Method
304+
## <a name="accelerator_view__wait"></a> wait
305+
290306
Waits for all commands submitted to the accelerator_view object to finish.
291307

292308
### Syntax
@@ -301,7 +317,8 @@ void wait();
301317
#### Remarks
302318
If the [queuing_mode](concurrency-namespace-enums-amp.md#queuing_mode) is `immediate`, this method returns immediately without blocking.
303319

304-
## <a name="dtor"></a> accelerator_view::~accelerator_view Destructor
320+
## <a name="dtor"></a> ~accelerator_view
321+
305322
Destroys the accelerator_view object.
306323

307324
#### Syntax

docs/parallel/amp/reference/accelerator-view-removed-class.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,13 @@ class accelerator_view_removed : public runtime_exception;
5050

5151
|Name|Description|
5252
|----------|-----------------|
53-
|[accelerator_view_removed::accelerator_view_removed Constructor](#ctor)|Initializes a new instance of the `accelerator_view_removed` class.|
53+
|[accelerator_view_removed Constructor](#ctor)|Initializes a new instance of the `accelerator_view_removed` class.|
5454

5555
### Public Methods
5656

5757
|Name|Description|
5858
|----------|-----------------|
59-
|[accelerator_view_removed::get_view_removed_reason Method](#get_view_removed_reason)|Returns an HRESULT error code indicating the cause of the `accelerator_view` object's removal.|
59+
|[get_view_removed_reason Method](#get_view_removed_reason)|Returns an HRESULT error code indicating the cause of the `accelerator_view` object's removal.|
6060

6161
## Inheritance Hierarchy
6262
`exception`
@@ -70,7 +70,8 @@ class accelerator_view_removed : public runtime_exception;
7070

7171
**Namespace:** Concurrency
7272

73-
## <a name="ctor"></a> accelerator_view_removed::accelerator_view_removed Constructor
73+
## <a name="ctor"></a> accelerator_view_removed
74+
7475
Initializes a new instance of the [accelerator_view_removed](accelerator-view-removed-class.md) class.
7576

7677
### Syntax
@@ -94,7 +95,8 @@ explicit accelerator_view_removed(
9495
### Return Value
9596
A new instance of the accelerator_view_removed class.
9697

97-
## <a name="get_view_removed_reason_method"></a> accelerator_view_removed::get_view_removed_reason Method
98+
## <a name="get_view_removed_reason_method"></a> get_view_removed_reason
99+
98100
Returns an HRESULT error code indicating the cause of the `accelerator_view` object's removal.
99101

100102
### Syntax

0 commit comments

Comments
 (0)