Skip to content

Commit 3d7fb37

Browse files
author
mtx48109
committed
cpp formatting review pr12
1 parent 4dd72c1 commit 3d7fb37

30 files changed

Lines changed: 69 additions & 87 deletions

‎docs/cpp/abort-function.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ ms.workload: ["cplusplus"]
1313
---
1414
# abort Function
1515

16-
The **abort** function, also declared in the standard include file \<stdlib.h>, terminates a C++ program. The difference between **exit** and **abort** is that **exit** allows the C++ run-time termination processing to take place (global object destructors will be called), whereas **abort** terminates the program immediately. For more information, see [abort](../c-runtime-library/reference/abort.md) in the *Run-Time Library Reference*.
16+
The **abort** function, also declared in the standard include file \<stdlib.h>, terminates a C++ program. The difference between `exit` and **abort** is that `exit` allows the C++ run-time termination processing to take place (global object destructors will be called), whereas **abort** terminates the program immediately. For more information, see [abort](../c-runtime-library/reference/abort.md) in the *Run-Time Library Reference*.
1717

1818
## See also
19-
2019
[Program Termination](../cpp/program-termination.md)

‎docs/cpp/abstract-classes-cpp.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,5 +84,4 @@ When the object pointed to by `pDerived` is deleted, the destructor for class `d
8484
> In the preceding example, the pure virtual function `base::~base` is called implicitly from `derived::~derived`. It is also possible to call pure virtual functions explicitly using a fully qualified member-function name.
8585

8686
## See also
87-
88-
- [Inheritance](../cpp/inheritance-cpp.md)
87+
[Inheritance](../cpp/inheritance-cpp.md)

‎docs/cpp/additional-startup-considerations.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@ ms.author: "mblome"
1212
ms.workload: ["cplusplus"]
1313
---
1414
# Additional Startup Considerations
15-
In C++, object construction and destruction can involve executing user code. Therefore, it is important to understand which initializations happen before entry to **main** and which destructors are invoked after exit from **main**. (For detailed information about construction and destruction of objects, see [Constructors](../cpp/constructors-cpp.md) and [Destructors](../cpp/destructors-cpp.md).)
15+
In C++, object construction and destruction can involve executing user code. Therefore, it is important to understand which initializations happen before entry to `main` and which destructors are invoked after exit from `main`. (For detailed information about construction and destruction of objects, see [Constructors](../cpp/constructors-cpp.md) and [Destructors](../cpp/destructors-cpp.md).)
1616

17-
The following initializations take place prior to entry to **main**:
17+
The following initializations take place prior to entry to `main`:
1818

1919
- Default initialization of static data to zero. All static data without explicit initializers are set to zero prior to executing any other code, including run-time initialization. Static data members must still be explicitly defined.
2020

21-
- Initialization of global static objects in a translation unit. This may occur either before entry to **main** or before the first use of any function or object in the object's translation unit.
21+
- Initialization of global static objects in a translation unit. This may occur either before entry to `main` or before the first use of any function or object in the object's translation unit.
2222

2323
**Microsoft Specific**
2424

25-
In Microsoft C++, global static objects are initialized before entry to **main**.
25+
In Microsoft C++, global static objects are initialized before entry to `main`.
2626

2727
**END Microsoft Specific**
2828

2929
Global static objects that are mutually interdependent but in different translation units may cause incorrect behavior.
3030

31-
## See Also
31+
## See also
3232
[Startup and Termination](../cpp/startup-and-termination-cpp.md)

‎docs/cpp/additional-termination-considerations.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.author: "mblome"
1212
ms.workload: ["cplusplus"]
1313
---
1414
# Additional Termination Considerations
15-
You can terminate a C++ program by using **exit**, **return**, or **abort**. You can add exit processing using the `atexit` function. These are discussed in the following sections.
15+
You can terminate a C++ program by using `exit`, **return**, or `abort`. You can add exit processing using the `atexit` function. These are discussed in the following sections.
1616

17-
## See Also
17+
## See also
1818
[Startup and Termination](../cpp/startup-and-termination-cpp.md)

‎docs/cpp/additive-operators-plus-and.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,11 @@ for( int i = 0; i < 10; ++i )
9898
> Code of the form `pIntArray = pIntArray + 1` is rarely found in C++ programs; to perform an increment, these forms are preferable: `pIntArray++` or `pIntArray += 1`.
9999
100100
## Pointer subtraction
101-
If both operands are pointers, the result of subtraction is the difference (in array elements) between the operands. The subtraction expression yields a signed integral result of type **ptrdiff_t** (defined in the standard include file \<stddef.h>).
101+
If both operands are pointers, the result of subtraction is the difference (in array elements) between the operands. The subtraction expression yields a signed integral result of type `ptrdiff_t` (defined in the standard include file \<stddef.h>).
102102

103103
One of the operands can be of integral type, as long as it is the second operand. The result of the subtraction is of the same type as the original pointer. The value of the subtraction is a pointer to the (*n* - *i*)th array element, where *n* is the element pointed to by the original pointer and *i* is the integral value of the second operand.
104104

105-
## See Also
105+
## See also
106106
[Expressions with Binary Operators](../cpp/expressions-with-binary-operators.md)
107107
[C++ Built-in Operators, Precedence and Associativity](../cpp/cpp-built-in-operators-precedence-and-associativity.md)
108-
[C Additive Operators](../c-language/c-additive-operators.md)
108+
[C Additive Operators](../c-language/c-additive-operators.md)

‎docs/cpp/address-of-operator-amp.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ ms.workload: ["cplusplus"]
2424

2525
The address-of operator can only be applied to variables with fundamental, structure, class, or union types that are declared at the file-scope level, or to subscripted array references. In these expressions, a constant expression that does not include the address-of operator can be added to or subtracted from the address-of expression.
2626

27-
When applied to functions or l-values, the result of the expression is a pointer type (an r-value) derived from the type of the operand. For example, if the operand is of type **char**, the result of the expression is of type pointer to **char**. The address-of operator, applied to **const** or **volatile** objects, evaluates to **const type \*** or **volatile type \***, where **type** is the type of the original object.
27+
When applied to functions or l-values, the result of the expression is a pointer type (an r-value) derived from the type of the operand. For example, if the operand is of type **char**, the result of the expression is of type pointer to **char**. The address-of operator, applied to **const** or **volatile** objects, evaluates to `const type *` or `volatile type *`, where **type** is the type of the original object.
2828

2929
When the address-of operator is applied to a qualified name, the result depends on whether the *qualified-name* specifies a static member. If so, the result is a pointer to the type specified in the declaration of the member. If the member is not static, the result is a pointer to the member *name* of the class indicated by *qualified-class-name*. (See [Primary Expressions](../cpp/primary-expressions.md) for more about *qualified-class-name*.) The following code fragment shows how the result differs, depending on whether the member is static:
3030

@@ -69,7 +69,7 @@ int main() {
6969

7070
## Output
7171

72-
```
72+
```Output
7373
&d equals &rd
7474
```
7575

@@ -96,12 +96,12 @@ int main() {
9696
9797
## Output
9898
99-
```
99+
```Output
100100
25
101101
```
102102

103-
## See Also
103+
## See also
104104
[Expressions with Unary Operators](../cpp/expressions-with-unary-operators.md)
105105
[C++ Built-in Operators, Precedence and Associativity](../cpp/cpp-built-in-operators-precedence-and-associativity.md)
106106
[Lvalue Reference Declarator: &](../cpp/lvalue-reference-declarator-amp.md)
107-
[Indirection and Address-of Operators](../c-language/indirection-and-address-of-operators.md)
107+
[Indirection and Address-of Operators](../c-language/indirection-and-address-of-operators.md)

‎docs/cpp/algorithms-modern-cpp.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,16 +60,16 @@ auto i = find_if( begin(v), end(v), [=](int i) { return i > x && i < y; } );
6060
### Range-based for loops
6161
The range-based **for** loop is a C++11 language feature, not a C++ Standard Library algorithm. But it deserves mention in this discussion about loops. Range-based **for** loops are an extension of the **for** keyword and provide a convenient and efficient way to write loops that iterate over a range of values. C++ Standard Library containers, strings, and arrays are ready-made for range-based **for** loops. To enable this new iteration syntax for your user-defined type, add the following support:
6262
63-
- A **begin** method that returns an iterator to the beginning of the structure and an **end** method that returns an iterator to the end of the structure.
63+
- A `begin` method that returns an iterator to the beginning of the structure and an `end` method that returns an iterator to the end of the structure.
6464
6565
- Support in the iterator for these methods: **operator***, **operator!=**, and **operator++** (prefix version).
6666
6767
These methods can be either members or stand-alone functions.
6868
6969
## Random Numbers
70-
It's no secret that the old CRT **rand()** function has many flaws, which have been discussed at length in the C++ community. In modern C++, you don't have to deal with those shortcomings—nor do you have to invent your own uniformly distributed random number generator—because the tools for quickly and easily creating them are available in the C++ Standard Library, as shown in [\<random>](../standard-library/random.md).
70+
It's no secret that the old CRT `rand()` function has many flaws, which have been discussed at length in the C++ community. In modern C++, you don't have to deal with those shortcomings—nor do you have to invent your own uniformly distributed random number generator—because the tools for quickly and easily creating them are available in the C++ Standard Library, as shown in [\<random>](../standard-library/random.md).
7171
72-
## See Also
72+
## See also
7373
[Welcome Back to C++](../cpp/welcome-back-to-cpp-modern-cpp.md)
7474
[C++ Language Reference](../cpp/cpp-language-reference.md)
7575
[C++ Standard Library](../standard-library/cpp-standard-library-reference.md)

‎docs/cpp/aliases-and-typedefs-cpp.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ using identifier = type;
2121
```
2222

2323
## Remarks
24-
`identifier`
24+
*identifier*
2525
The name of the alias.
2626

27-
`type`
27+
*type*
2828
The type identifier you are creating an alias for.
2929

3030
An alias does not introduce a new type and cannot change the meaning of an existing type name.
@@ -167,7 +167,6 @@ int main()
167167
// typedef UL back in scope
168168
```
169169

170-
171170
```cpp
172171
// typedef_specifier1.cpp
173172
typedef char FlagType;
@@ -349,4 +348,4 @@ typedef struct {
349348

350349
- The name cannot be used as constructor or destructor names within a class declaration.
351350

352-
In summary, this syntax does not provide any mechanism for inheritance, construction, or destruction.
351+
In summary, this syntax does not provide any mechanism for inheritance, construction, or destruction.

‎docs/cpp/align-cpp.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The compiler does not guarantee or attempt to preserve the alignment attribute o
3838

3939
You cannot specify alignment for function parameters. When data that has an alignment attribute is passed by value on the stack, its alignment is controlled by the calling convention. If data alignment is important in the called function, copy the parameter into correctly aligned memory before use.
4040

41-
Without `__declspec(align(#))`, the compiler generally aligns data on natural boundaries based on the target processor and the size of the data, up to 4-byte boundaries on 32-bit processors, and 8-byte boundaries on 64-bit processors. Data in classes or structures is aligned in the class or structure at the minimum of its natural alignment and the current packing setting (from #pragma **pack** or the **/Zp** compiler option).
41+
Without `__declspec(align(#))`, the compiler generally aligns data on natural boundaries based on the target processor and the size of the data, up to 4-byte boundaries on 32-bit processors, and 8-byte boundaries on 64-bit processors. Data in classes or structures is aligned in the class or structure at the minimum of its natural alignment and the current packing setting (from #pragma `pack` or the `/Zp` compiler option).
4242

4343
This example demonstrates the use of `__declspec(align(#))`:
4444

@@ -167,7 +167,7 @@ void fn() {
167167
}
168168
```
169169

170-
The alignment when memory is allocated on the heap depends on which allocation function is called. For example, if you use **malloc**, the result depends on the operand size. If *arg* >= 8, the memory returned is 8 byte aligned. If *arg* < 8, the alignment of the memory returned is the first power of 2 less than *arg*. For example, if you use malloc(7), the alignment is 4 bytes.
170+
The alignment when memory is allocated on the heap depends on which allocation function is called. For example, if you use `malloc`, the result depends on the operand size. If *arg* >= 8, the memory returned is 8 byte aligned. If *arg* < 8, the alignment of the memory returned is the first power of 2 less than *arg*. For example, if you use malloc(7), the alignment is 4 bytes.
171171

172172
## <a name="vclrf_declspecaligntypedef"></a> Defining New Types with __declspec(align(#))
173173

@@ -207,9 +207,9 @@ __declspec(thread) struct S9 a;
207207

208208
## <a name="vclrfhowalignworkswithdatapacking"></a> How align Works with Data Packing
209209

210-
The **/Zp** compiler option and the **pack** pragma have the effect of packing data for structure and union members.This example shows how **/Zp** and `__declspec(align(#))` work together:
210+
The `/Zp` compiler option and the `pack` pragma have the effect of packing data for structure and union members.This example shows how `/Zp` and `__declspec(align(#))` work together:
211211

212-
```c[[]]
212+
```cpp
213213
struct S {
214214
char a;
215215
short b;
@@ -220,7 +220,7 @@ struct S {
220220
};
221221
```
222222
223-
The following table lists the offset of each member under a variety of **/Zp** (or #pragma **pack**) values, showing how the two interact.
223+
The following table lists the offset of each member under a variety of `/Zp` (or #pragma `pack`) values, showing how the two interact.
224224
225225
|Variable|/Zp1|/Zp2|/Zp4|/Zp8|
226226
|--------------|-----------|-----------|-----------|-----------|
@@ -239,7 +239,6 @@ The offset of an object is based on the offset of the previous object and the cu
239239
**END Microsoft Specific**
240240
241241
## See also
242-
243242
[__declspec](../cpp/declspec.md)
244243
[Overview of ARM ABI Conventions](../build/overview-of-arm-abi-conventions.md)
245-
[Overview of x64 Calling Conventions](../build/overview-of-x64-calling-conventions.md)
244+
[Overview of x64 Calling Conventions](../build/overview-of-x64-calling-conventions.md)

‎docs/cpp/alignment-cpp-declarations.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ struct x_
5252
char d; // 1 byte
5353
char _pad1[1]; // padding to make sizeof(x_) multiple of 4
5454
}
55-
5655
```
5756
5857
1. Both declarations return sizeof(struct x_) as 12 bytes.
@@ -90,8 +89,7 @@ adr offset element
9089
0x0020 short c;
9190
0x0022 char d;
9291
0x0023 char _pad1[1];
93-
9492
```
9593
96-
## See Also
94+
## See also
9795
[Data Structure Alignment](http://en.wikipedia.org/wiki/Data_structure_alignment)

0 commit comments

Comments
 (0)