cpp formatting review pr18

mtx48109 · mtx48109 · commit bf5eae4affc4 · 2018-07-31T14:38:24.000-07:00
diff --git a/docs/cpp/general-rules-and-limitations.md b/docs/cpp/general-rules-and-limitations.md
@@ -85,5 +85,5 @@ ms.workload: ["cplusplus"]
   
 **END Microsoft Specific**  
   
-## See Also  
+## See also  
  [dllexport, dllimport](../cpp/dllexport-dllimport.md)
diff --git a/docs/cpp/general-rules-for-operator-overloading.md b/docs/cpp/general-rules-for-operator-overloading.md
@@ -49,7 +49,7 @@ The following rules constrain how overloaded operators are implemented. However,
   
 -   Overloaded operators cannot have default arguments.  
   
--   All overloaded operators except assignment (`operator=`) are inherited by derived classes.  
+-   All overloaded operators except assignment (**operator=**) are inherited by derived classes.  
   
 -   The first argument for member-function overloaded operators is always of the class type of the object for which the operator is invoked (the class in which the operator is declared, or a class derived from that class). No conversions are supplied for the first argument.  
   
@@ -62,10 +62,10 @@ var++;
 ++var;  
 ```  
   
- This identity cannot be relied upon for class types that overload operators. Moreover, some of the requirements implicit in the use of these operators for basic types are relaxed for overloaded operators. For example, the addition/assignment operator, `+=`, requires the left operand to be an l-value when applied to basic types; there is no such requirement when the operator is overloaded.  
+ This identity cannot be relied upon for class types that overload operators. Moreover, some of the requirements implicit in the use of these operators for basic types are relaxed for overloaded operators. For example, the addition/assignment operator, **+=**, requires the left operand to be an l-value when applied to basic types; there is no such requirement when the operator is overloaded.  
   
 > [!NOTE]
 > For consistency, it is often best to follow the model of the built-in types when defining overloaded operators. If the semantics of an overloaded operator differ significantly from its meaning in other contexts, it can be more confusing than useful.  
   
-## See Also  
+## See also  
  [Operator Overloading](../cpp/operator-overloading.md)
diff --git a/docs/cpp/goto-statement-cpp.md b/docs/cpp/goto-statement-cpp.md
@@ -74,6 +74,6 @@ Outer loop executing. i = 3
 Jumped to stop. i = 3  
 ```  
   
-## See Also  
+## See also  
  [Jump Statements](../cpp/jump-statements-cpp.md)   
  [Keywords](../cpp/keywords-cpp.md)
diff --git a/docs/cpp/hardware-exceptions.md b/docs/cpp/hardware-exceptions.md
@@ -35,6 +35,6 @@ Most of the standard exceptions recognized by the operating system are hardware-
   
  Many of the exceptions listed in the previous table are intended to be handled by debuggers, the operating system, or other low-level code. With the exception of integer and floating-point errors, your code should not handle these errors. Thus, you should usually use the exception-handling filter to ignore exceptions (evaluate to 0). Otherwise, you may prevent lower-level mechanisms from responding appropriately. You can, however, take appropriate precautions against the potential effect of these low-level errors by [writing termination handlers](../cpp/writing-a-termination-handler.md).  
   
-## See Also  
+## See also  
  [Writing an Exception Handler](../cpp/writing-an-exception-handler.md)   
  [Structured Exception Handling (C/C++)](../cpp/structured-exception-handling-c-cpp.md)
diff --git a/docs/cpp/header-files-cpp.md b/docs/cpp/header-files-cpp.md
@@ -82,24 +82,24 @@ After the compiler finishes compiling each .cpp file into .obj files, it passes
 
 ## Include guards
 
-Typically, header files have an *include guard* or a **#pragma once** directive to ensure that they are not inserted multiple times into a single .cpp file. 
+Typically, header files have an *include guard* or a `#pragma once` directive to ensure that they are not inserted multiple times into a single .cpp file. 
 
+```cpp
 // my_class.h
 #ifndef MY_CLASS_H // include guard
 #define MY_CLASS_H
 
-
 namespace N
 {
     class my_class
     {
     public:
         void do_something();
     };
-
 }
 
 #endif /* MY_CLASS_H */
+```
 
 ## What to put in a header file
 
@@ -125,15 +125,13 @@ The following example shows the various kinds of declarations and definitions th
 
 namespace N  // namespace declaration
 {
-
     inline namespace P
     {
         //...
     }
 
     enum class colors : short { red, blue, purple, azure };
 
-
     const double PI = 3.14;  // const and constexpr definitions
     constexpr int MeaningOfLife{ 42 };
     constexpr int get_meaning()
@@ -150,7 +148,6 @@ namespace N  // namespace declaration
     void print_to_log();
 #endif
 
-
     class my_class   // regular class definition, 
     {                // but no non-inline function definitions
 
@@ -186,5 +183,5 @@ namespace N  // namespace declaration
 
     template <typename T>  // template declaration
     class value_widget;
-
 }
+```
diff --git a/docs/cpp/hook.md b/docs/cpp/hook.md
@@ -18,7 +18,6 @@ Associates a handler method with an event.
 ## Syntax  
   
 ```  
-  
 long __hook(  
    &SourceClass::EventMethod,  
    source,  
@@ -91,7 +90,7 @@ long __hook(
 ## Example  
  See [Event Handling in Native C++](../cpp/event-handling-in-native-cpp.md) and [Event Handling in COM](../cpp/event-handling-in-com.md) for samples.  
   
-## See Also  
+## See also  
  [Keywords](../cpp/keywords-cpp.md)   
  [Event Handling](../cpp/event-handling.md)   
  [event_source](../windows/event-source.md)   
diff --git a/docs/cpp/how-catch-blocks-are-evaluated-cpp.md b/docs/cpp/how-catch-blocks-are-evaluated-cpp.md
@@ -59,5 +59,5 @@ catch( CExcptClass E )
   
  In this example, the ellipsis **catch** handler is the only handler that is examined.  
   
-## See Also  
+## See also  
  [C++ Exception Handling](../cpp/cpp-exception-handling.md)
diff --git a/docs/cpp/how-to-create-and-use-ccomptr-and-ccomqiptr-instances.md b/docs/cpp/how-to-create-and-use-ccomptr-and-ccomqiptr-instances.md
@@ -32,5 +32,5 @@ In classic Windows programming, libraries are often implemented as COM objects (
   
  [!code-cpp[COM_smart_pointers#03](../cpp/codesnippet/CPP/how-to-create-and-use-ccomptr-and-ccomqiptr-instances_3.cpp)]  
   
-## See Also  
+## See also  
  [Smart Pointers](../cpp/smart-pointers-modern-cpp.md)
diff --git a/docs/cpp/how-to-create-and-use-shared-ptr-instances.md b/docs/cpp/how-to-create-and-use-shared-ptr-instances.md
@@ -57,5 +57,5 @@ The `shared_ptr` type is a smart pointer in the C++ standard library that is des
   
  [!code-cpp[stl_smart_pointers#3](../cpp/codesnippet/CPP/how-to-create-and-use-shared-ptr-instances_6.cpp)]  
   
-## See Also  
+## See also  
  [Smart Pointers](../cpp/smart-pointers-modern-cpp.md)
diff --git a/docs/cpp/how-to-create-and-use-unique-ptr-instances.md b/docs/cpp/how-to-create-and-use-unique-ptr-instances.md
@@ -45,6 +45,6 @@ A [unique_ptr](../standard-library/unique-ptr-class.md) does not share its point
   
  For more examples, see [make_unique](../standard-library/memory-functions.md#make_unique).  
   
-## See Also  
+## See also  
  [Smart Pointers](../cpp/smart-pointers-modern-cpp.md)   
- [make_unique](../standard-library/memory-functions.md#make_unique)
+ [make_unique](../standard-library/memory-functions.md#make_unique)
diff --git a/docs/cpp/how-to-create-and-use-weak-ptr-instances.md b/docs/cpp/how-to-create-and-use-weak-ptr-instances.md
@@ -81,5 +81,5 @@ Press any key
 
  As an experiment, modify the vector `others` to be a `vector<shared_ptr<Controller>>`, and then in the output, notice that no destructors are invoked when `TestRun` returns.  
 
-## See Also  
+## See also  
  [Smart Pointers](../cpp/smart-pointers-modern-cpp.md)
diff --git a/docs/cpp/how-to-design-for-exception-safety.md b/docs/cpp/how-to-design-for-exception-safety.md
@@ -77,7 +77,6 @@ private:
 public:  
     SPShapeResourceClass() : m_p(new Circle), m_q(new Triangle) { }  
 };  
-  
 ```  
   
 ### Use the RAII Idiom to Manage Resources  
@@ -110,6 +109,6 @@ public:
   
 -   Do not allow any exceptions to escape from a destructor. A basic axiom of C++ is that destructors should never allow an exception to propagate up the call stack. If a destructor must perform a potentially exception-throwing operation, it must do so in a try catch block and swallow the exception. The standard library provides this guarantee on all destructors it defines.  
   
-## See Also  
+## See also  
  [Errors and Exception Handling](../cpp/errors-and-exception-handling-modern-cpp.md)   
  [How to: Interface Between Exceptional and Non-Exceptional Code](../cpp/how-to-interface-between-exceptional-and-non-exceptional-code.md)
diff --git a/docs/cpp/how-to-interface-between-exceptional-and-non-exceptional-code.md b/docs/cpp/how-to-interface-between-exceptional-and-non-exceptional-code.md
@@ -152,7 +152,6 @@ int main ( int argc, char* argv[] )
         cout.copyfmt(state); // restore previous formatting  
     }  
 }  
-  
 ```  
   
 ## Calling Exceptional Code from Non-Exceptional Code  
@@ -185,7 +184,6 @@ BOOL DiffFiles2(const string& file1, const string& file2)
     }   
     return FALSE;   
 }  
-  
 ```  
   
  When you convert from exceptions to error codes, one potential issue is that error codes often don't contain the richness of information that an exception can store. To address this, you can provide a **catch** block for each specific exception type that might be thrown, and perform logging to record the details of the exception before it is converted to an error code. This approach can create a lot of code repetition if multiple functions all use the same set of **catch** blocks. A good way to avoid code repetition is by refactoring those blocks into one private utility function that implements the **try** and **catch** blocks and accepts a function object that is invoked in the **try** block. In each public function, pass the code to the utility function as a lambda expression.  
@@ -208,7 +206,6 @@ bool Win32ExceptionBoundary(Func&& f)
     }   
     return false;   
 }  
-  
 ```  
   
  The following example shows how to write the lambda expression that defines the functor. When a functor is defined "inline" by using a lambda expression, it is often easier to read than it would be if it were written as a named function object.  
@@ -228,11 +225,10 @@ bool DiffFiles3(const string& file1, const string& file2)
         return true;   
     });   
 }  
-  
 ```  
   
  For more information about lambda expressions, see [Lambda Expressions](../cpp/lambda-expressions-in-cpp.md).  
   
-## See Also  
+## See also  
  [Errors and Exception Handling](../cpp/errors-and-exception-handling-modern-cpp.md)   
  [How to: Design for Exception Safety](../cpp/how-to-design-for-exception-safety.md)
diff --git a/docs/cpp/identifiers-cpp.md b/docs/cpp/identifiers-cpp.md
@@ -67,7 +67,7 @@ N O P Q R S T U V W X Y Z
   
  The dollar sign `$` is a valid identifier character in Visual C++. Visual C++ also allows you to use the actual characters represented by the allowed ranges of universal character names in identifiers. To use these characters, you must save the file by using a file encoding codepage that includes them.  This example shows how both extended characters and universal character names can be used interchangeably in your code.  
   
-```  
+```cpp  
 // extended_identifier.cpp  
 // In Visual Studio, use File, Advanced Save Options to set  
 // the file encoding to Unicode codepage 1200  
@@ -92,5 +92,5 @@ int main() {
   
  Use of two sequential underscore characters ( **__** ) at the beginning of an identifier, or a single leading underscore followed by a capital letter, is reserved for C++ implementations in all scopes. You should avoid using one leading underscore followed by a lowercase letter for names with file scope because of possible conflicts with current or future reserved identifiers.  
   
-## See Also  
+## See also  
  [Lexical Conventions](../cpp/lexical-conventions.md)
diff --git a/docs/cpp/if-else-statement-cpp.md b/docs/cpp/if-else-statement-cpp.md
@@ -22,7 +22,6 @@ Controls conditional branching. Statements in the *if-block* are executed only i
 ## Syntax  
   
 ```  
-  
 if ( expression )  
 {
    statement1;
@@ -117,7 +116,6 @@ int main()
 #include <string>
 #include <algorithm>
 
-
 using namespace std;
 
 map<int, string> m;
@@ -145,13 +143,11 @@ int main()
 		shared_flag = false;
 	}
 
-
 	string s{ "if" };
     if (auto keywords = { "if", "for", "while" }; any_of(keywords.begin(), keywords.end(), [&s](const char* kw) { return s == kw; }))
 	{
 		cout << "Error! Token must not be a keyword\n";
 	}
-
 }
 ```
 
@@ -182,9 +178,7 @@ void f(T&& t, Rest&&... r)
 }
 ```
 
-  
- 
-## See Also  
+## See also  
  [Selection Statements](../cpp/selection-statements-cpp.md)   
  [Keywords](../cpp/keywords-cpp.md)   
  [switch Statement (C++)](../cpp/switch-statement-cpp.md)
diff --git a/docs/cpp/if-exists-statement.md b/docs/cpp/if-exists-statement.md
@@ -27,8 +27,8 @@ statements
   
 |Parameter|Description|  
 |---------------|-----------------|  
-|`identifier`|The identifier whose existence you want to test.|  
-|`statements`|One or more statements to execute if `identifier` exists.|  
+|*identifier*|The identifier whose existence you want to test.|  
+|*statements*|One or more statements to execute if *identifier* exists.|  
   
 ## Remarks  
   
@@ -116,7 +116,7 @@ g_bFlag = 1
 C::f exists  
 ```  
   
-## See Also  
+## See also  
  [Selection Statements](../cpp/selection-statements-cpp.md)   
  [Keywords](../cpp/keywords-cpp.md)   
  [__if_not_exists Statement](../cpp/if-not-exists-statement.md)
diff --git a/docs/cpp/if-not-exists-statement.md b/docs/cpp/if-not-exists-statement.md
@@ -27,8 +27,8 @@ statements
   
 |Parameter|Description|  
 |---------------|-----------------|  
-|`identifier`|The identifier whose existence you want to test.|  
-|`statements`|One or more statements to execute if `identifier` does not exist.|  
+|*identifier*|The identifier whose existence you want to test.|  
+|*statements*|One or more statements to execute if *identifier* does not exist.|  
   
 ## Remarks  
   
@@ -48,7 +48,7 @@ statements
 ## Example  
  For an example about how to use **__if_not_exists**, see [__if_exists Statement](../cpp/if-exists-statement.md).  
   
-## See Also  
+## See also  
  [Selection Statements](../cpp/selection-statements-cpp.md)   
  [Keywords](../cpp/keywords-cpp.md)   
  [__if_exists Statement](../cpp/if-exists-statement.md)
diff --git a/docs/cpp/increment-and-decrement-operator-overloading-cpp.md b/docs/cpp/increment-and-decrement-operator-overloading-cpp.md
@@ -120,7 +120,7 @@ int main()
 }  
 ```  
   
- There is no syntax for using the increment or decrement operators to pass these values other than explicit invocation, as shown in the preceding code. A more straightforward way to implement this functionality is to overload the addition/assignment operator (`+=`).  
+ There is no syntax for using the increment or decrement operators to pass these values other than explicit invocation, as shown in the preceding code. A more straightforward way to implement this functionality is to overload the addition/assignment operator (**+=**).  
   
-## See Also  
+## See also  
  [Operator Overloading](../cpp/operator-overloading.md)
diff --git a/docs/cpp/indirection-on-array-types.md b/docs/cpp/indirection-on-array-types.md
@@ -14,5 +14,5 @@ ms.workload: ["cplusplus"]
 # Indirection on Array Types
 Use of the indirection operator (**\***) on an *n*-dimensional array type yields an *n*-1 dimensional array. If *n* is 1, a scalar (or array element) is yielded.  
   
-## See Also  
+## See also  
  [Arrays](../cpp/arrays-cpp.md)
diff --git a/docs/cpp/indirection-operator-star.md b/docs/cpp/indirection-operator-star.md
@@ -15,7 +15,6 @@ ms.workload: ["cplusplus"]
 ## Syntax  
   
 ```  
-  
 * cast-expression  
 ```  
   
@@ -56,7 +55,7 @@ int main() {
   
 -   The pointer specifies an address not used by the executing program.  
   
-## See Also  
+## See also  
  [Expressions with Unary Operators](../cpp/expressions-with-unary-operators.md)   
  [C++ Built-in Operators, Precedence and Associativity](../cpp/cpp-built-in-operators-precedence-and-associativity.md)   
  [Address-of Operator: &](../cpp/address-of-operator-amp.md)   
diff --git a/docs/cpp/inheritance-cpp.md b/docs/cpp/inheritance-cpp.md
@@ -49,5 +49,5 @@ After the tag (name) for the class, a colon appears followed by a list of base s
   
  The [__super](../cpp/super.md) and [__interface](../cpp/interface.md) keywords are documented in this section.  
   
-## See Also  
- [C++ Language Reference](../cpp/cpp-language-reference.md)
+## See also  
+ [C++ Language Reference](../cpp/cpp-language-reference.md)
diff --git a/docs/cpp/inheritance-keywords.md b/docs/cpp/inheritance-keywords.md
@@ -62,5 +62,5 @@ int S::*p;
   
  **END Microsoft Specific**  
   
-## See Also  
+## See also  
  [Keywords](../cpp/keywords-cpp.md)
diff --git a/docs/cpp/initializers.md b/docs/cpp/initializers.md
diff --git a/docs/cpp/initializing-arrays.md b/docs/cpp/initializing-arrays.md
diff --git a/docs/cpp/initializing-classes-and-structs-without-constructors-cpp.md b/docs/cpp/initializing-classes-and-structs-without-constructors-cpp.md
diff --git a/docs/cpp/inline-functions-cpp.md b/docs/cpp/inline-functions-cpp.md
diff --git a/docs/cpp/int8-int16-int32-int64.md b/docs/cpp/int8-int16-int32-int64.md
diff --git a/docs/cpp/integer-limits.md b/docs/cpp/integer-limits.md
diff --git a/docs/cpp/interface.md b/docs/cpp/interface.md
diff --git a/docs/cpp/interpretation-of-subscript-operator.md b/docs/cpp/interpretation-of-subscript-operator.md
