Merge pull request #8 from MicrosoftDocs/master

bringing in the sheep

Author: WilliamAntonRohm

docs/code-quality/best-practices-and-examples-sal.md

@@ -145,7 +145,7 @@ BOOL StrEquals2(_In_ PSTR p1, _In_ PSTR p2)
 
 ```
 
-## \_Out_range\_
+## \_Out\_range\_
 
 If the parameter is a pointer and you want to express the range of the value of the element that is pointed to by the pointer, use `_Deref_out_range_` instead of `_Out_range_`. In the following example, the range of *pcbFilled is expressed, not pcbFilled.
 

docs/code-quality/c26130.md

@@ -16,7 +16,7 @@ ms.workload:
   - "multiple"
 ---
 # C26130
-warning C26130: Missing annotation _Requires_lock_held\_(\<lock>) or _No_competing_thread\_ at function \<func>. Otherwise it could be a race condition. Variable \<var> should be protected by lock \<lock>.
+warning C26130: Missing annotation \_Requires\_lock\_held\_(\<lock>) or \_No\_competing\_thread\_ at function \<func>. Otherwise it could be a race condition. Variable \<var> should be protected by lock \<lock>.
 
  Warning C26130 is issued when the analyzer detects a potential race condition but infers that the function is likely to be run in a single threaded mode, for example, when the function is in the initialization stage based on certain heuristics.
 

docs/code-quality/c28020.md

@@ -18,6 +18,6 @@ ms.workload:
 # C28020
 warning C28020: The expression \<expr> is not true at this call
 
- This warning is reported when the _Satisfies\_ expression listed is not true. Frequently this indicates an incorrect parameter.
+ This warning is reported when the \_Satisfies\_ expression listed is not true. Frequently this indicates an incorrect parameter.
 
  If this occurs on a function declaration, the annotations indicate an impossible condition.

docs/code-quality/c28216.md

@@ -16,6 +16,6 @@ ms.workload:
   - "multiple"
 ---
 # C28216
-warning C28216: The _Check_return\_ annotation only applies to post-conditions for the specific function parameter.
+warning C28216: The \_Check\_return\_ annotation only applies to post-conditions for the specific function parameter.
 
  The `_Check_return_` annotation has been applied in a context other than `__post`; it may need a `__post` (or `__drv_out`) modifier, or it may be placed incorrectly.

docs/code-quality/c28222.md

@@ -16,6 +16,6 @@ ms.workload:
   - "multiple"
 ---
 # C28222
-warning 28222: _Yes\_, _No\_, or _Maybe\_ expected for annotation
+warning 28222: \_Yes\_, \_No\_, or \_Maybe\_ expected for annotation
 
  This warning indicates that a parameter to an annotation is expected to be one of the symbols `_Yes_`, `_No_`, or `_Maybe_`, and some other symbol was encountered. This usually indicates an incorrectly coded annotation macro.

docs/code-quality/c28232.md

@@ -16,6 +16,6 @@ ms.workload:
   - "multiple"
 ---
 # C28232
-warning C28232: _Pre\_, _Post\_, or _Deref\_ not applied to any annotation
+warning C28232: \_Pre\_, \_Post\_, or \_Deref\_ not applied to any annotation
 
  This warning indicates that a `_Pre_`, `_Post_`, or `_Deref_` operator appears in an annotation expression without a subsequent functional annotation; the modifier was ignored, but this indicates an incorrectly coded annotation.

docs/code-quality/c28234.md

@@ -16,6 +16,6 @@ ms.workload:
   - "multiple"
 ---
 # C28234
-warning C28234: _At\_ expression does not apply to current function
+warning C28234: \_At\_ expression does not apply to current function
 
  This warning indicates that the value of an `_At_` expression does not identify an accessible object.

docs/code-quality/c28275.md

@@ -16,6 +16,6 @@ ms.workload:
   - "multiple"
 ---
 # C28275
-warning C28275: The parameter to _Macro_value\_ is null
+warning C28275: The parameter to \_Macro\_value\_ is null
 
  This warning indicates that there is an internal error in the model file, not in the code being analyzed. The *macroValue* function was called without a parameter.

docs/code-quality/c28287.md

@@ -16,6 +16,6 @@ ms.workload:
   - "multiple"
 ---
 # C28287
-warning C28287: For function, syntax Error in _At\_() annotation (unrecognized parameter name)
+warning C28287: For function, syntax Error in \_At\_() annotation (unrecognized parameter name)
 
  The Code Analysis tool reports this warning when the `SAL_at` (`__drv_at`) annotation is used and the parameter expression cannot be interpreted in the current context. This might include using a misspelled parameter or member name, or a misspelling of "return" or "this" keywords.

docs/code-quality/c28288.md

@@ -16,6 +16,6 @@ ms.workload:
   - "multiple"
 ---
 # C28288
-warning C28288: For function, syntax Error in _At\_() annotation (invalid parameter name)
+warning C28288: For function, syntax Error in \_At\_() annotation (invalid parameter name)
 
  The Code Analysis tool reports this warning when the `SAL_at` (`__drv_at`) annotation is used and the parameter expression cannot be interpreted in the current context. This might include using a misspelled parameter or member name, or a misspelling of "return" or "this" keywords.

docs/code-quality/c6517.md

@@ -16,7 +16,7 @@ ms.workload:
   - "multiple"
 ---
 # C6517
-warning C6517: Invalid annotation: 'SAL_readableTo' property may not be specified on buffers that are not readable: '_Param\_(1)'.
+warning C6517: Invalid annotation: 'SAL_readableTo' property may not be specified on buffers that are not readable: '\_Param\_(1)'.
 
 > [!NOTE]
 >  This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).

docs/code-quality/c6518.md

@@ -16,7 +16,7 @@ ms.workload:
   - "multiple"
 ---
 # C6518
-warning C6518: Invalid annotation: 'SAL_writableTo' property may not be specified as a precondition on buffers that are not writable: '_Param\_(1)'
+warning C6518: Invalid annotation: 'SAL_writableTo' property may not be specified as a precondition on buffers that are not writable: '\_Param\_(1)'
 
  This warning indicates that a conflict exists between a `SAL_writableTo` property value and a writable property. This ordinarily indicates that a writable property does not have write access to the parameter being annotated.
 

docs/code-quality/media/error-list-filter.png

@@ -79,13 +79,13 @@ The Microsoft Mixed Minimum Rules focus on the most critical problems in your C+
 |[C28182](../code-quality/c28182.md)|Dereferencing NULL pointer. The pointer contains the same NULL value as another pointer did.|
 |[C28202](../code-quality/c28202.md)|Illegal reference to non-static member|
 |[C28203](../code-quality/c28203.md)|Ambiguous reference to class member.|
-|[C28205](../code-quality/c28205.md)|_Success\_ or _On_failure\_ used in an illegal context|
+|[C28205](../code-quality/c28205.md)|\_Success\_ or \_On\_failure\_ used in an illegal context|
 |[C28206](../code-quality/c28206.md)|Left operand points to a struct, use '->'|
 |[C28207](../code-quality/c28207.md)|Left operand is a struct, use '.'|
 |[C28210](../code-quality/c28210.md)|Annotations for the __on_failure context must not be in explicit pre context|
 |[C28211](../code-quality/c28211.md)|Static context name expected for SAL_context|
 |[C28212](../code-quality/c28212.md)|Pointer expression expected for annotation|
-|[C28213](../code-quality/c28213.md)|The _Use_decl_annotations\_ annotation must be used to reference, without modification, a prior declaration.|
+|[C28213](../code-quality/c28213.md)|The \_Use\_decl\_annotations\_ annotation must be used to reference, without modification, a prior declaration.|
 |[C28214](../code-quality/c28214.md)|Attribute parameter names must be p1...p9|
 |[C28215](../code-quality/c28215.md)|The typefix cannot be applied to a parameter that already has a typefix|
 |[C28216](../code-quality/c28216.md)|The checkReturn annotation only applies to postconditions for the specific function parameter.|
@@ -127,22 +127,22 @@ The Microsoft Mixed Minimum Rules focus on the most critical problems in your C+
 |[C28267](../code-quality/c28267.md)|A syntax error in the annotations was found annotation in the function.|
 |[C28272](../code-quality/c28272.md)|The annotation for function, parameter when examining is inconsistent with the function declaration|
 |[C28273](../code-quality/c28273.md)|For function, the clues are inconsistent with the function declaration|
-|[C28275](../code-quality/c28275.md)|The parameter to _Macro_value\_ is null|
+|[C28275](../code-quality/c28275.md)|The parameter to \_Macro\_value\_ is null|
 |[C28279](../code-quality/c28279.md)|For symbol, a 'begin' was found without a matching 'end'|
 |[C28280](../code-quality/c28280.md)|For symbol, an 'end' was found without a matching 'begin'|
 |[C28282](../code-quality/c28282.md)|Format Strings must be in preconditions|
 |[C28285](../code-quality/c28285.md)|For function, syntax error in parameter|
 |[C28286](../code-quality/c28286.md)|For function, syntax error near the end|
-|[C28287](../code-quality/c28287.md)|For function, syntax Error in _At\_() annotation (unrecognized parameter name)|
-|[C28288](../code-quality/c28288.md)|For function, syntax Error in _At\_() annotation (invalid parameter name)|
+|[C28287](../code-quality/c28287.md)|For function, syntax Error in \_At\_() annotation (unrecognized parameter name)|
+|[C28288](../code-quality/c28288.md)|For function, syntax Error in \_At\_() annotation (invalid parameter name)|
 |[C28289](../code-quality/c28289.md)|For function: ReadableTo or WritableTo did not have a limit-spec as a parameter|
 |[C28290](../code-quality/c28290.md)|the annotation for function contains more Externals than the actual number of parameters|
 |[C28291](../code-quality/c28291.md)|post null/notnull at deref level 0 is meaningless for function.|
 |[C28300](../code-quality/c28300.md)|Expression operands of incompatible types for operator|
 |[C28301](../code-quality/c28301.md)|No annotations for first declaration of function.|
-|[C28302](../code-quality/c28302.md)|An extra _Deref\_ operator was found on annotation.|
-|[C28303](../code-quality/c28303.md)|An ambiguous _Deref\_ operator was found on annotation.|
-|[C28304](../code-quality/c28304.md)|An improperly placed _Notref\_ operator was found applied to token.|
+|[C28302](../code-quality/c28302.md)|An extra \_Deref\_ operator was found on annotation.|
+|[C28303](../code-quality/c28303.md)|An ambiguous \_Deref\_ operator was found on annotation.|
+|[C28304](../code-quality/c28304.md)|An improperly placed \_Notref\_ operator was found applied to token.|
 |[C28305](../code-quality/c28305.md)|An error while parsing a token was discovered.|
 |[C28350](../code-quality/c28350.md)|The annotation describes a situation that is not conditionally applicable.|
 |[C28351](../code-quality/c28351.md)|The annotation describes where a dynamic value (a variable) cannot be used in the condition.|

docs/code-quality/mixed-minimum-rules-rule-set.md

@@ -145,7 +145,7 @@ The Microsoft Mixed Recommended Rules focus on the most common and critical prob
 |[C28020](../code-quality/c28020.md)|The expression is not true at this call|
 |[C28021](../code-quality/c28021.md)|The parameter being annotated must be a pointer|
 |[C28022](../code-quality/c28022.md)|The function class(es) on this function do not match the function class(es) on the typedef used to define it.|
-|[C28023](../code-quality/c28023.md)|The function being assigned or passed should have a _Function_class\_ annotation for at least one of the class(es)|
+|[C28023](../code-quality/c28023.md)|The function being assigned or passed should have a \_Function\_class\_ annotation for at least one of the class(es)|
 |[C28024](../code-quality/c28024.md)|The function pointer being assigned to is annotated with the function class, which is not contained in the function class(es) list.|
 |[C28039](../code-quality/c28039.md)|The type of actual parameter should exactly match the type|
 |[C28112](../code-quality/c28112.md)|A variable which is accessed via an Interlocked function must always be accessed via an Interlocked function.|
@@ -163,14 +163,14 @@ The Microsoft Mixed Recommended Rules focus on the most common and critical prob
 |[C28196](../code-quality/c28196.md)|The requirement is not satisfied. (The expression does not evaluate to true.)|
 |[C28202](../code-quality/c28202.md)|Illegal reference to non-static member|
 |[C28203](../code-quality/c28203.md)|Ambiguous reference to class member.|
-|[C28205](../code-quality/c28205.md)|_Success\_ or _On_failure\_ used in an illegal context|
+|[C28205](../code-quality/c28205.md)|\_Success\_ or \_On\_failure\_ used in an illegal context|
 |[C28206](../code-quality/c28206.md)|Left operand points to a struct, use '->'|
 |[C28207](../code-quality/c28207.md)|Left operand is a struct, use '.'|
 |[C28209](../code-quality/c28209.md)|The declaration for symbol has a conflicting declaration|
 |[C28210](../code-quality/c28210.md)|Annotations for the __on_failure context must not be in explicit pre context|
 |[C28211](../code-quality/c28211.md)|Static context name expected for SAL_context|
 |[C28212](../code-quality/c28212.md)|Pointer expression expected for annotation|
-|[C28213](../code-quality/c28213.md)|The _Use_decl_annotations\_ annotation must be used to reference, without modification, a prior declaration.|
+|[C28213](../code-quality/c28213.md)|The \_Use\_decl\_annotations\_ annotation must be used to reference, without modification, a prior declaration.|
 |[C28214](../code-quality/c28214.md)|Attribute parameter names must be p1...p9|
 |[C28215](../code-quality/c28215.md)|The typefix cannot be applied to a parameter that already has a typefix|
 |[C28216](../code-quality/c28216.md)|The checkReturn annotation only applies to postconditions for the specific function parameter.|
@@ -213,22 +213,22 @@ The Microsoft Mixed Recommended Rules focus on the most common and critical prob
 |[C28267](../code-quality/c28267.md)|A syntax error in the annotations was found annotation in the function.|
 |[C28272](../code-quality/c28272.md)|The annotation for function, parameter when examining is inconsistent with the function declaration|
 |[C28273](../code-quality/c28273.md)|For function, the clues are inconsistent with the function declaration|
-|[C28275](../code-quality/c28275.md)|The parameter to _Macro_value\_ is null|
+|[C28275](../code-quality/c28275.md)|The parameter to \_Macro\_value\_ is null|
 |[C28279](../code-quality/c28279.md)|For symbol, a 'begin' was found without a matching 'end'|
 |[C28280](../code-quality/c28280.md)|For symbol, an 'end' was found without a matching 'begin'|
 |[C28282](../code-quality/c28282.md)|Format Strings must be in preconditions|
 |[C28285](../code-quality/c28285.md)|For function, syntax error in parameter|
 |[C28286](../code-quality/c28286.md)|For function, syntax error near the end|
-|[C28287](../code-quality/c28287.md)|For function, syntax Error in _At\_() annotation (unrecognized parameter name)|
-|[C28288](../code-quality/c28288.md)|For function, syntax Error in _At\_() annotation (invalid parameter name)|
+|[C28287](../code-quality/c28287.md)|For function, syntax Error in \_At\_() annotation (unrecognized parameter name)|
+|[C28288](../code-quality/c28288.md)|For function, syntax Error in \_At\_() annotation (invalid parameter name)|
 |[C28289](../code-quality/c28289.md)|For function: ReadableTo or WritableTo did not have a limit-spec as a parameter|
 |[C28290](../code-quality/c28290.md)|the annotation for function contains more Externals than the actual number of parameters|
 |[C28291](../code-quality/c28291.md)|post null/notnull at deref level 0 is meaningless for function.|
 |[C28300](../code-quality/c28300.md)|Expression operands of incompatible types for operator|
 |[C28301](../code-quality/c28301.md)|No annotations for first declaration of function.|
-|[C28302](../code-quality/c28302.md)|An extra _Deref\_ operator was found on annotation.|
-|[C28303](../code-quality/c28303.md)|An ambiguous _Deref\_ operator was found on annotation.|
-|[C28304](../code-quality/c28304.md)|An improperly placed _Notref\_ operator was found applied to token.|
+|[C28302](../code-quality/c28302.md)|An extra \_Deref\_ operator was found on annotation.|
+|[C28303](../code-quality/c28303.md)|An ambiguous \_Deref\_ operator was found on annotation.|
+|[C28304](../code-quality/c28304.md)|An improperly placed \_Notref\_ operator was found applied to token.|
 |[C28305](../code-quality/c28305.md)|An error while parsing a token was discovered.|
 |[C28306](../code-quality/c28306.md)|The annotation on parameter is obsolescent|
 |[C28307](../code-quality/c28307.md)|The annotation on parameter is obsolescent|