Skip to content

Commit d4a4f41

Browse files
v-dirichardsv-dirichards
authored
Merge pull request #5338 from Rageking8/elide-manual-table-of-contents
Elide manual table of contents
2 parents 16d70c4 + eee5982 commit d4a4f41

33 files changed

+121
-310
lines changed

‎docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
---
2-
description: "Learn more about: Concurrency::graphics namespace functions"
32
title: "Concurrency::graphics namespace functions"
4-
ms.date: "11/04/2016"
3+
description: "Learn more about: Concurrency::graphics namespace functions"
4+
ms.date: 11/04/2016
55
f1_keywords: ["amp_graphics/Concurrency::fast_math::copy_async", "amp_graphics/Concurrency::fast_math::copy"]
6-
ms.assetid: ace01cd5-29d3-4356-930e-c81a61c5f934
76
---
87
# Concurrency::graphics namespace functions
98

10-
[copy](#copy)\
11-
[copy_async](#copy_async)
9+
The following functions are available in the `Concurrency::graphics` namespace:
1210

1311
## <a name="copy"></a> copy Function (Concurrency::graphics Namespace)
1412

‎docs/parallel/amp/reference/concurrency-namespace-constants-amp.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
11
---
2-
description: "Learn more about: Concurrency namespace constants (AMP)"
32
title: "Concurrency namespace constants (AMP)"
4-
ms.date: "11/04/2016"
3+
description: "Learn more about: Concurrency namespace constants (AMP)"
4+
ms.date: 11/04/2016
55
f1_keywords: ["amp/Concurrency::HLSL_MAX_NUM_BUFFERS", "amp/Concurrency::MODULENAME_MAX_LENGTH"]
6-
ms.assetid: 13a8e8cd-2eec-4e60-a91d-5d271072747b
76
---
87
# Concurrency namespace constants (AMP)
98

10-
[HLSL_MAX_NUM_BUFFERS](#hlsl_max_num_buffers)\
11-
[MODULENAME_MAX_LENGTH](#modulename_max_length)
9+
The following constants are defined in the `Concurrency` namespace (AMP):
1210

13-
## <a name="hlsl_max_num_buffers"></a> HLSL_MAX_NUM_BUFFERS Constant
11+
## <a name="hlsl_max_num_buffers"></a> `HLSL_MAX_NUM_BUFFERS` Constant
1412

1513
The maximum number of buffers allowed by DirectX.
1614

1715
```cpp
1816
static const UINT HLSL_MAX_NUM_BUFFERS = 64 + 128;
1917
```
2018

21-
## <a name="modulename_max_length"></a> MODULENAME_MAX_LENGTH Constant
19+
## <a name="modulename_max_length"></a> `MODULENAME_MAX_LENGTH` constant
2220

23-
Stores the maximum length of the module name. This value must be the same on the compiler and runtime.
21+
Stores the maximum length of the module name. This value must be the same at compile time and runtime.
2422

2523
```cpp
2624
static const UINT MODULENAME_MAX_LENGTH = 1024;

‎docs/parallel/amp/reference/concurrency-namespace-enums-amp.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
---
2-
description: "Learn more about: Concurrency namespace enums (AMP)"
32
title: "Concurrency namespace enums (AMP)"
4-
ms.date: "11/04/2016"
3+
description: "Learn more about: Concurrency namespace enums (AMP)"
4+
ms.date: 11/04/2016
55
f1_keywords: ["amp/Concurrency::access_type", "amp/Concurrency::queuing_mode"]
6-
ms.assetid: 4c87457e-184f-4992-81ab-ca75e7d524ab
76
---
8-
# Concurrency namespace enums (AMP)
9-
10-
[access_type Enumeration](#access_type)\
11-
[queuing_mode Enumeration](#queuing_mode)
7+
# `Concurrency` namespace enums (AMP)
128

13-
## <a name="access_type"></a> access_type Enumeration
9+
The following enumerations are available in the `Concurrency` namespace:
1410

15-
Enumeration type used to denote the various types of access to data.
11+
## <a name="access_type"></a> `access_type` enumeration
1612

1713
```cpp
1814
enum access_type;
@@ -28,7 +24,7 @@ enum access_type;
2824
|`access_type_read_write`|Shared. The allocation is accessible on the accelerator and is writable on the CPU.|
2925
|`access_type_write`|Shared. The allocation is accessible on the accelerator and is both readable and writable on the CPU.|
3026

31-
## <a name="queuing_mode"></a> queuing_mode Enumeration
27+
## <a name="queuing_mode"></a> `queuing_mode` enumeration
3228

3329
Specifies the queuing modes that are supported on the accelerator.
3430

‎docs/parallel/openmp/c-openmp-c-and-cpp-grammar.md‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
---
2-
description: "Learn more about: C. OpenMP C and C++ grammar"
32
title: "C. OpenMP C and C++ grammar"
4-
ms.date: "01/16/2019"
5-
ms.assetid: 97a878ce-1533-47f7-a134-66fcbff48524
3+
description: "Learn more about: C. OpenMP C and C++ grammar"
4+
ms.date: 01/16/2019
65
---
76
# C. OpenMP C and C++ grammar
87

9-
[C.1 Notation](#c1-notation)<br/>
10-
[C.2 Rules](#c2-rules)
8+
Learn about the grammar rules and syntax extensions in C and C++ for OpenMP, a parallel programming framework.
119

12-
## C.1 Notation
10+
## C.1 notation
1311

1412
The grammar rules consist of the name for a non-terminal, followed by a colon, followed by replacement alternatives on separate lines.
1513

@@ -22,7 +20,7 @@ The syntactic expression *term*<sub>optseq</sub> is equivalent to *term-seq*<sub
2220
&emsp;*term-seq* *term*\
2321
&emsp;*term-seq* `,` *term*
2422

25-
## C.2 Rules
23+
## C.2 rules
2624

2725
The notation is described in section 6.1 of the C standard. This grammar appendix shows the extensions to the base language grammar for the OpenMP C and C++ directives.
2826

‎docs/standard-library/atomic-functions.md‎

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,13 @@
11
---
22
title: "<atomic> functions"
33
description: "Learn more about: <atomic> functions"
4-
ms.date: "07/11/2018"
4+
ms.date: 07/11/2018
55
f1_keywords: ["atomic/std::atomic_compare_exchange_strong", "atomic/std::atomic_compare_exchange_strong_explicit", "atomic/std::atomic_compare_exchange_weak", "atomic/std::atomic_compare_exchange_weak_explicit", "atomic/std::atomic_exchange", "atomic/std::atomic_exchange_explicit", "atomic/std::atomic_fetch_add", "atomic/std::atomic_fetch_add_explicit", "atomic/std::atomic_fetch_and", "atomic/std::atomic_fetch_and_explicit", "atomic/std::atomic_fetch_or", "atomic/std::atomic_fetch_or_explicit", "atomic/std::atomic_fetch_sub", "atomic/std::atomic_fetch_sub_explicit", "atomic/std::atomic_fetch_xor", "atomic/std::atomic_fetch_xor_explicit", "atomic/std::atomic_flag_clear", "atomic/std::atomic_flag_clear_explicit", "atomic/std::atomic_flag_test_and_set", "atomic/std::atomic_flag_test_and_set_explicit", "atomic/std::atomic_init", "atomic/std::atomic_is_lock_free", "atomic/std::atomic_load", "atomic/std::atomic_load_explicit", "atomic/std::atomic_signal_fence", "atomic/std::atomic_store", "atomic/std::atomic_store_explicit", "atomic/std::atomic_thread_fence", "atomic/std::kill_dependency"]
66
helpviewer_keywords: ["std::atomic_compare_exchange_strong [C++]", "std::atomic_compare_exchange_strong_explicit [C++]", "std::atomic_compare_exchange_weak [C++]", "std::atomic_compare_exchange_weak_explicit [C++]", "std::atomic_exchange [C++]", "std::atomic_exchange_explicit [C++]", "std::atomic_fetch_add [C++]", "std::atomic_fetch_add_explicit [C++]", "std::atomic_fetch_and [C++]", "std::atomic_fetch_and_explicit [C++]", "std::atomic_fetch_or [C++]", "std::atomic_fetch_or_explicit [C++]", "std::atomic_fetch_sub [C++]", "std::atomic_fetch_sub_explicit [C++]", "std::atomic_fetch_xor [C++]", "std::atomic_fetch_xor_explicit [C++]", "std::atomic_flag_clear [C++]", "std::atomic_flag_clear_explicit [C++]", "std::atomic_flag_test_and_set [C++]", "std::atomic_flag_test_and_set_explicit [C++]", "std::atomic_init [C++]", "std::atomic_is_lock_free [C++]", "std::atomic_load [C++]", "std::atomic_load_explicit [C++]", "std::atomic_signal_fence [C++]", "std::atomic_store [C++]", "std::atomic_store_explicit [C++]", "std::atomic_thread_fence [C++]", "std::kill_dependency [C++]"]
77
---
88
# `<atomic>` functions
99

10-
[atomic_compare_exchange_strong](#atomic_compare_exchange_strong)\
11-
[atomic_compare_exchange_strong_explicit](#atomic_compare_exchange_strong_explicit)\
12-
[atomic_compare_exchange_weak](#atomic_compare_exchange_weak)\
13-
[atomic_compare_exchange_weak_explicit](#atomic_compare_exchange_weak_explicit)\
14-
[atomic_exchange](#atomic_exchange)\
15-
[atomic_exchange_explicit](#atomic_exchange_explicit)\
16-
[atomic_fetch_add](#atomic_fetch_add)\
17-
[atomic_fetch_add_explicit](#atomic_fetch_add_explicit)\
18-
[atomic_fetch_and](#atomic_fetch_and)\
19-
[atomic_fetch_and_explicit](#atomic_fetch_and_explicit)\
20-
[atomic_fetch_or](#atomic_fetch_or)\
21-
[atomic_fetch_or_explicit](#atomic_fetch_or_explicit)\
22-
[atomic_fetch_sub](#atomic_fetch_sub)\
23-
[atomic_fetch_sub_explicit](#atomic_fetch_sub_explicit)\
24-
[atomic_fetch_xor](#atomic_fetch_xor)\
25-
[atomic_fetch_xor_explicit](#atomic_fetch_xor_explicit)\
26-
[atomic_flag_clear](#atomic_flag_clear)\
27-
[atomic_flag_clear_explicit](#atomic_flag_clear_explicit)\
28-
[atomic_flag_test_and_set](#atomic_flag_test_and_set)\
29-
[atomic_flag_test_and_set_explicit](#atomic_flag_test_and_set_explicit)\
30-
[atomic_init](#atomic_init)\
31-
[atomic_is_lock_free](#atomic_is_lock_free)\
32-
[atomic_load](#atomic_load)\
33-
[atomic_load_explicit](#atomic_load_explicit)\
34-
[atomic_signal_fence](#atomic_signal_fence)\
35-
[atomic_store](#atomic_store)\
36-
[atomic_store_explicit](#atomic_store_explicit)\
37-
[atomic_thread_fence](#atomic_thread_fence)\
38-
[kill_dependency](#kill_dependency)
10+
The `<atomic>` header provides the following functions:
3911

4012
## <a name="atomic_compare_exchange_strong"></a> `atomic_compare_exchange_strong`
4113

‎docs/standard-library/fstream-typedefs.md‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,12 @@
11
---
2-
description: "Learn more about: <fstream> typedefs"
32
title: "<fstream> typedefs"
4-
ms.date: "11/04/2016"
3+
description: "Learn more about: <fstream> typedefs"
4+
ms.date: 11/04/2016
55
f1_keywords: ["fstream/std::filebuf", "fstream/std::fstream", "fstream/std::ifstream", "fstream/std::ofstream", "fstream/std::wfilebuf", "fstream/std::wfstream", "fstream/std::wifstream", "fstream/std::wofstream"]
6-
ms.assetid: 8dddef2d-7f17-42a6-ba08-6f6f20597d23
76
---
87
# `<fstream>` typedefs
98

10-
[`filebuf`](#filebuf)\
11-
[`fstream`](#fstream)\
12-
[`ifstream`](#ifstream)\
13-
[`ofstream`](#ofstream)\
14-
[`wfilebuf`](#wfilebuf)\
15-
[`wfstream`](#wfstream)\
16-
[`wifstream`](#wifstream)\
17-
[`wofstream`](#wofstream)
9+
The `<fstream>` header provides the following typedefs:
1810

1911
## <a name="filebuf"></a> `filebuf`
2012

‎docs/standard-library/future-enums.md‎

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
11
---
2-
description: "Learn more about: <future> enums"
32
title: "<future> enums"
4-
ms.date: "11/04/2016"
3+
description: "Learn more about: <future> enums"
4+
ms.date: 11/04/2016
55
f1_keywords: ["future/std::future_errc", "future/std::future_status", "future/std::launch"]
6-
ms.assetid: 8c675645-db47-4cab-bc0e-7b87f8a302df
76
---
87
# `<future>` enums
98

10-
[future_errc](#future_errc)\
11-
[future_status](#future_status)\
12-
[launch](#launch)
9+
The `<future>` header provides the following enums:
1310

14-
## <a name="future_errc"></a> future_errc Enumeration
11+
## <a name="future_errc"></a> `future_errc` enumeration
1512

16-
Supplies symbolic names for all of the errors that are reported by the [future_error](../standard-library/future-error-class.md) class.
13+
Supplies symbolic names for all of the errors that are reported by the [`future_error`](../standard-library/future-error-class.md) class.
1714

1815
```cpp
1916
class future_errc {
@@ -24,7 +21,7 @@ class future_errc {
2421
};
2522
```
2623
27-
## <a name="future_status"></a> future_status Enumeration
24+
## <a name="future_status"></a> `future_status` enumeration
2825
2926
Supplies symbolic names for the reasons that a timed wait function can return.
3027
@@ -36,9 +33,9 @@ enum future_status{
3633
};
3734
```
3835

39-
## <a name="launch"></a> launch Enumeration
36+
## <a name="launch"></a> `launch` enumeration
4037

41-
Represents a bitmask type that describes the possible modes for the template function [async](../standard-library/future-functions.md#async).
38+
Represents a bitmask type that describes the possible modes for the template function [`async`](../standard-library/future-functions.md#async).
4239

4340
```cpp
4441
class launch{
@@ -49,4 +46,4 @@ class launch{
4946
5047
## See also
5148
52-
[\<future>](../standard-library/future.md)
49+
[\<future>](future.md)

‎docs/standard-library/future-functions.md‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
11
---
2-
description: "Learn more about: <future> functions"
32
title: "<future> functions"
3+
description: "Learn more about: <future> functions"
44
ms.date: 09/11/2024
55
f1_keywords: ["future/std::async", "future/std::future_category", "future/std::make_error_code", "future/std::make_error_condition", "future/std::swap"]
66
helpviewer_keywords: ["std::async [C++]", "std::future_category [C++]", "std::make_error_code [C++]", "std::make_error_condition [C++]", "std::swap [C++]"]
77
---
88
# `<future>` functions
99

10-
[`async`](#async)\
11-
[`future_category`](#future_category)\
12-
[`make_error_code`](#make_error_code)\
13-
[`make_error_condition`](#make_error_condition)\
14-
[`swap`](#swap)|
10+
The `<future>` header provides the following functions:
1511

1612
## <a name="async"></a> `async`
1713

‎docs/standard-library/hash-map-functions.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ f1_keywords: ["hash_map/std::swap", "hash_map/std::swap (hash_map)"]
66
---
77
# `<hash_map>` functions
88

9-
[swap](#swap)\
10-
[swap (hash_map)](#swap_hash_map)
9+
The `<hash_map>` header provides the following functions:
1110

12-
## <a name="swap_hash_map"></a> swap (hash_map)
11+
## <a name="swap_hash_map"></a> `swap` (`hash_map`)
1312

1413
> [!NOTE]
1514
> This API is obsolete. The alternative is [unordered_map Class](../standard-library/unordered-map-class.md).
@@ -24,17 +23,17 @@ void swap(
2423
2524
### Parameters
2625
27-
*right*\
28-
The hash_map whose elements are to be exchanged with those of the map *left*.
26+
*`right`*\
27+
The hash_map whose elements are to be exchanged with those of the map *`left`*.
2928
30-
*left*\
31-
The hash_map whose elements are to be exchanged with those of the map *right*.
29+
*`left`*\
30+
The hash_map whose elements are to be exchanged with those of the map *`right`*.
3231
3332
### Remarks
3433
35-
The template function is an algorithm specialized on the container class hash_map to execute the member function `left.`[swap](../standard-library/basic-ios-class.md#swap)*(right*). This is an instance of the partial ordering of function templates by the compiler. When template functions are overloaded in such a way that the match of the template with the function call is not unique, then the compiler will select the most specialized version of the template function. The general version of the template function, **template \<class T> void swap(T&, T&)**, in the algorithm header file works by assignment and is a slow operation. The specialized version in each container is much faster as it can work with the internal representation of the container class.
34+
The template function is an algorithm specialized on the container class hash_map to execute the member function `left.`[`swap`](../standard-library/basic-ios-class.md#swap)(`right`). This is an instance of the partial ordering of function templates by the compiler. When template functions are overloaded in such a way that the match of the template with the function call is not unique, then the compiler will select the most specialized version of the template function. The general version of the template function, **`template <class T> void swap(T&, T&)`**, in the algorithm header file works by assignment and is a slow operation. The specialized version in each container is much faster as it can work with the internal representation of the container class.
3635
37-
## <a name="swap"></a> swap
36+
## <a name="swap"></a> `swap`
3837
3938
> [!NOTE]
4039
> This API is obsolete. The alternative is [unordered_multimap Class](../standard-library/unordered-multimap-class.md).
@@ -49,16 +48,16 @@ void swap(
4948

5049
### Parameters
5150

52-
*right*\
53-
The hash_multimap whose elements are to be exchanged with those of the map *left*.
51+
*`right`*\
52+
The `hash_multimap` whose elements are to be exchanged with those of the map *`left`*.
5453

55-
*left*\
56-
The hash_multimap whose elements are to be exchanged with those of the map *right*.
54+
*`left`*\
55+
The `hash_multimap` whose elements are to be exchanged with those of the map *`right`*.
5756

5857
### Remarks
5958

60-
The template function is an algorithm specialized on the container class hash_multimap to execute the member function `left.`[swap](../standard-library/hash-multimap-class.md#swap)*(right*`)`. This is an instance of the partial ordering of function templates by the compiler. When template functions are overloaded in such a way that the match of the template with the function call is not unique, then the compiler will select the most specialized version of the template function. The general version of the template function, **template \<class T> void swap(T&, T&)**, in the algorithm header file works by assignment and is a slow operation. The specialized version in each container is much faster as it can work with the internal representation of the container class.
59+
The template function is an algorithm specialized on the container class hash_multimap to execute the member function `left.`[`swap`](../standard-library/hash-multimap-class.md#swap)(`right`). This is an instance of the partial ordering of function templates by the compiler. When template functions are overloaded in such a way that the match of the template with the function call is not unique, then the compiler will select the most specialized version of the template function. The general version of the template function, **`template <class T> void swap(T&, T&)`**, in the algorithm header file works by assignment and is a slow operation. The specialized version in each container is much faster as it can work with the internal representation of the container class.
6160

6261
## See also
6362

64-
[<hash_map>](../standard-library/hash-map.md)
63+
[`<hash_map>`](../standard-library/hash-map.md)

‎docs/standard-library/hash-map-operators.md‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
11
---
2-
description: "Learn more about: <hash_map> operators"
32
title: "<hash_map> operators"
4-
ms.date: "11/04/2016"
3+
description: "Learn more about: <hash_map> operators"
4+
ms.date: 11/04/2016
55
f1_keywords: ["hash_map/std::operator!=", "hash_map/std::operator=="]
6-
ms.assetid: 24b9bb9e-e983-4060-bce5-2c7c8161ee61
76
---
87
# `<hash_map>` operators
98

10-
[operator!=](#op_neq)\
11-
[operator!= (multimap)](#op_neq_mm)\
12-
[operator==](#op_eq_eq)\
13-
[operator== (multimap)](#op_eq_eq_mm)
9+
The `<hash_map>` header provides the following operators:
1410

1511
## <a name="op_neq"></a> operator!=
1612

0 commit comments

Comments
 (0)