Merge pull request #3774 from hvitved/csharp/tripleticks

C#: Enable syntax highlighting in QLDoc snippets

Author: calumgrant

csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/Initializer.cs

@@ -74,7 +74,7 @@ protected override void PopulateExpression(TextWriter trapFile)
                     var typeInfoRight = cx.GetTypeInfo(assignment.Right);
                     if (typeInfoRight.Type is null)
                         // The type may be null for nested initializers such as
-                        // ```
+                        // ```csharp
                         // new ClassWithArrayField() { As = { [0] = a } }
                         // ```
                         // In this case we take the type from the assignment

csharp/ql/src/Security Features/CWE-451/MissingXFrameOptions.ql

@@ -20,7 +20,7 @@ import semmle.code.csharp.frameworks.system.Web
  */
 predicate hasWebConfigXFrameOptions(WebConfigXML webConfig) {
   // Looking for an entry in `webConfig` that looks like this:
-  // ```
+  // ```xml
   // <system.webServer>
   //   <httpProtocol>
   //    <customHeaders>

csharp/ql/src/Stubs/Stubs.qll

@@ -5,7 +5,7 @@
  * This will generate stubs for all the required dependencies as well.
  *
  * Use
- * ```
+ * ```ql
  * select generatedCode()
  * ```
  * to retrieve the generated C# code.

csharp/ql/src/experimental/ir/implementation/raw/internal/desugar/Foreach.qll

@@ -5,13 +5,13 @@
  * Also we only deal with foreach stmts where there is only
  * one declaration (see below).
  * For example the code:
- *    ```
+ *    ```csharp
  *      foreach(var item in some_enumerable) {
  *        // body
  *      }
  *    ```
  * gets desugared to:
- *    ```
+ *    ```csharp
  *      Enumerator e = some_enumerable.GetEnumerator();
  *      try
  *      {

csharp/ql/src/experimental/ir/implementation/raw/internal/desugar/Lock.qll

@@ -1,11 +1,11 @@
 /**
  * File that provides the desugaring of a `lock` stmt.
  * The statement:
- *    ```
+ *    ```csharp
  *      lock (anExpr) ...
  *    ```
  * gets desugared to:
- *    ```
+ *    ```csharp
  *      SomeRefType lockedVar = anExpr;
  *      bool __lockWasTaken = false;
  *      try {

csharp/ql/src/experimental/ir/implementation/unaliased_ssa/internal/AliasAnalysisImports.qll

@@ -12,7 +12,7 @@ module AliasModels {
      * the function returns.
      *
      * Example:
-     * ```
+     * ```csharp
      * int* g;
      * int* func(int* p, int* q, int* r, int* s, int n) {
      *   *s = 1;  // `s` does not escape.

csharp/ql/src/experimental/ir/internal/IRGuards.qll

@@ -93,7 +93,7 @@ class GuardCondition extends Expr {
  * implies that the truth of the child expression `part` has truth value `partIsTrue`.
  *
  * For example if the binary operation:
- * ```
+ * ```csharp
  *   x && y
  * ```
  * is true, `x` and `y` must also be true, so `impliesValue(x, true, true)` and
@@ -341,7 +341,7 @@ class IRGuardCondition extends Instruction {
    * predecessors. For example, in the following situation, an inference can be made about the
    * value of `x` at the end of the `if` statement, but there is no block which is controlled by
    * the `if` statement when `x >= y`.
-   * ```
+   * ```csharp
    * if (x < y) {
    *   x = y;
    * }

csharp/ql/src/experimental/ir/rangeanalysis/RangeAnalysis.qll

@@ -10,7 +10,7 @@
 
 /*
  * This library tackles range analysis as a flow problem. Consider e.g.:
- * ```
+ * ```csharp
  *   len = arr.length;
  *   if (x < len) { ... y = x-1; ... y ... }
  * ```

csharp/ql/src/semmle/code/asp/AspNet.qll

@@ -32,7 +32,7 @@ class AspAttribute extends AspElement, @asp_attribute { }
 /**
  * An open tag, for example the tag on line 1 in
  *
- * ```
+ * ```html
  * <script runat="server">
  *   Label.Text = "Hello, World!";
  * </script>
@@ -67,7 +67,7 @@ class AspOpenTag extends AspElement, @asp_open_tag {
 /**
  * A close tag, for example the tag on line 3 in
  *
- * ```
+ * ```html
  * <script runat="server">
  *   Label.Text = "Hello, World!";
  * </script>
@@ -123,7 +123,7 @@ class AspServerComment extends AspComment {
 /**
  * A data-binding expression, for example `<%# myArray %>` in
  *
- * ```
+ * ```html
  * <asp:ListBox id="List1" datasource='<%# myArray %>' runat="server">
  * ```
  */

csharp/ql/src/semmle/code/cil/BasicBlock.qll

@@ -23,7 +23,7 @@ class BasicBlock extends Cached::TBasicBlockStart {
    *
    * Example:
    *
-   * ```
+   * ```csharp
    * if (x < 0)
    *   x = -x;
    * ```
@@ -41,7 +41,7 @@ class BasicBlock extends Cached::TBasicBlockStart {
    *
    * Example:
    *
-   * ```
+   * ```csharp
    * if (!(x >= 0))
    *   x = -x;
    * ```
@@ -75,7 +75,7 @@ class BasicBlock extends Cached::TBasicBlockStart {
    *
    * Example:
    *
-   * ```
+   * ```csharp
    * int M(string s) {
    *   if (s == null)
    *     throw new ArgumentNullException(nameof(s));
@@ -97,7 +97,7 @@ class BasicBlock extends Cached::TBasicBlockStart {
    *
    * Example:
    *
-   * ```
+   * ```csharp
    * int M(string s) {
    *   if (s == null)
    *     throw new ArgumentNullException(nameof(s));
@@ -124,7 +124,7 @@ class BasicBlock extends Cached::TBasicBlockStart {
    *
    * Example:
    *
-   * ```
+   * ```csharp
    * if (x < 0) {
    *   x = -x;
    *   if (x > 10)
@@ -158,7 +158,7 @@ class BasicBlock extends Cached::TBasicBlockStart {
    *
    * Example:
    *
-   * ```
+   * ```csharp
    * int M(string s) {
    *   if (s == null)
    *     throw new ArgumentNullException(nameof(s));
@@ -182,7 +182,7 @@ class BasicBlock extends Cached::TBasicBlockStart {
    *
    * Example:
    *
-   * ```
+   * ```csharp
    * int M(string s) {
    *   try {
    *     return s.Length;
@@ -207,7 +207,7 @@ class BasicBlock extends Cached::TBasicBlockStart {
    *
    * Example:
    *
-   * ```
+   * ```csharp
    * int M(string s) {
    *   try {
    *     return s.Length;
@@ -353,15 +353,15 @@ class ConditionBlock extends BasicBlock {
      * all predecessors of `this.getATrueSuccessor()` are either `this` or dominated by `this.getATrueSuccessor()`.
      *
      * For example, in the following C# snippet:
-     * ```
+     * ```csharp
      * if (x)
      *   controlled;
      * false_successor;
      * uncontrolled;
      * ```
      * `false_successor` dominates `uncontrolled`, but not all of its predecessors are `this` (`if (x)`)
      *  or dominated by itself. Whereas in the following code:
-     * ```
+     * ```csharp
      * if (x)
      *   while (controlled)
      *     also_controlled;

csharp/ql/src/semmle/code/csharp/Assignable.qll

@@ -55,7 +55,7 @@ private predicate nameOfChild(NameOfExpr noe, Expr child) {
  *
  * For example, the last occurrence of `Length` in
  *
- * ```
+ * ```csharp
  * class C {
  *   int Length;
  *
@@ -89,7 +89,7 @@ class AssignableRead extends AssignableAccess {
    * that can be reached from this read without passing through any other reads,
    * and which is guaranteed to read the same value. Example:
    *
-   * ```
+   * ```csharp
    * int Field;
    *
    * void SetField(int i) {
@@ -131,7 +131,7 @@ class AssignableRead extends AssignableAccess {
  *
  * For example, the last occurrence of `Length` in
  *
- * ```
+ * ```csharp
  * class C {
  *   int Length;
  *
@@ -454,7 +454,7 @@ class AssignableDefinition extends TAssignableDefinition {
    * reads, and which is guaranteed to read the value assigned in this
    * definition. Example:
    *
-   * ```
+   * ```csharp
    * int Field;
    *
    * void SetField(int i) {
@@ -720,7 +720,7 @@ module AssignableDefinitions {
    * An initializer definition for a field or a property, for example
    * line 2 in
    *
-   * ```
+   * ```csharp
    * class C {
    *   int Field = 0;
    * }

csharp/ql/src/semmle/code/csharp/Attribute.qll

@@ -38,7 +38,7 @@ class Attributable extends @attributable {
 /**
  * An attribute, for example `[...]` on line 1 in
  *
- * ```
+ * ```csharp
  * [DllImport("kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]
  * public static extern int GetFinalPathNameByHandle(
  *   SafeHandle handle,
@@ -64,7 +64,7 @@ class Attribute extends TopLevelExprParent, @attribute {
    * Gets the `i`th constructor argument of this attribute. For example, only
    * `true` is a constructor argument in
    *
-   * ```
+   * ```csharp
    * MyAttribute[true, Foo = 0]
    * ```
    */
@@ -76,7 +76,7 @@ class Attribute extends TopLevelExprParent, @attribute {
    * Gets the named argument `name` of this attribute. For example, only
    * `0` is a named argument in
    *
-   * ```
+   * ```csharp
    * MyAttribute[true, Foo = 0]
    * ```
    */