From 70465b22c7f52b2b1cbbbd33842bc7a788fa833a Mon Sep 17 00:00:00 2001
From: Geoffrey White <40627776+geoffw0@users.noreply.github.com>
Date: Thu, 29 Feb 2024 15:55:14 +0000
Subject: [PATCH] Shared: Remove @ annotations.

---
 shared/dataflow/codeql/dataflow/DataFlow.qll   | 18 ++++++------------
 .../codeql/rangeanalysis/RangeAnalysis.qll     | 11 ++---------
 2 files changed, 8 insertions(+), 21 deletions(-)

diff --git a/shared/dataflow/codeql/dataflow/DataFlow.qll b/shared/dataflow/codeql/dataflow/DataFlow.qll
index ea44ec5d0ce..a22ac1e5bb1 100644
--- a/shared/dataflow/codeql/dataflow/DataFlow.qll
+++ b/shared/dataflow/codeql/dataflow/DataFlow.qll
@@ -50,9 +50,8 @@ signature module InputSig {
    */
   class PostUpdateNode extends Node {
     /**
-     * Gets the node that represents the same value prior to the operation.
-     *
-     * @return The pre-update node.
+     * Gets the pre-update node, that is, the node that represents the same
+     * value prior to the operation.
      */
     Node getPreUpdateNode();
   }
@@ -153,9 +152,7 @@ signature module InputSig {
   }
 
   /**
-   * Holds if high precision should be used for the given content.
-   *
-   * @param c The content to force high precision for.
+   * Holds if high precision should be used for the content `c`.
    */
   predicate forceHighPrecision(Content c);
 
@@ -199,16 +196,13 @@ signature module InputSig {
   }
 
   /**
-   * Holds if the given parameter position matches the argument position.
-   *
-   * @param ppos The parameter position.
+   * Holds if the parameter position `ppos` matches the argument position
+   * `apos`.
    */
   predicate parameterMatch(ParameterPosition ppos, ArgumentPosition apos);
 
   /**
-   * Holds if there is a simple local flow step between two nodes.
-   *
-   * @param node1 The first node in the flow step.
+   * Holds if there is a simple local flow step from `node1` to `node2`.
    */
   predicate simpleLocalFlowStep(Node node1, Node node2);
 
diff --git a/shared/rangeanalysis/codeql/rangeanalysis/RangeAnalysis.qll b/shared/rangeanalysis/codeql/rangeanalysis/RangeAnalysis.qll
index 97c4d2ac2f7..8a6d1f246c5 100644
--- a/shared/rangeanalysis/codeql/rangeanalysis/RangeAnalysis.qll
+++ b/shared/rangeanalysis/codeql/rangeanalysis/RangeAnalysis.qll
@@ -189,8 +189,6 @@ signature module Semantic {
      *   Console.WriteLine("x is greater than y");
      * }
      * ```
-     *
-     * @param controlled The basic block to check.
      */
     predicate directlyControls(BasicBlock controlled, boolean branch);
 
@@ -213,8 +211,6 @@ signature module Semantic {
      *   printf("x is not greater than y\n");
      * }
      * ```
-     *
-     * @param bb1 The first basic block.
      */
     predicate hasBranchEdge(BasicBlock bb1, BasicBlock bb2, boolean branch);
   }
@@ -280,9 +276,8 @@ signature module Semantic {
    */
   class SsaExplicitUpdate extends SsaVariable {
     /**
-     * Gets the expression that defines the value of the variable in this update.
-     *
-     * @return The defining expression.
+     * Gets the expression that defines the value of the variable in this
+     * update.
      */
     Expr getDefiningExpr();
   }
@@ -391,8 +386,6 @@ signature module BoundSig<LocationSig Location, Semantic Sem, DeltaSig D> {
 
     /**
      * Gets the expression associated with the semantic bound, given a delta.
-     *
-     * @param delta - The delta value.
      */
     Sem::Expr getExpr(D::Delta delta);
   }