Fix formatting of QLDocs

Author: owen-mc

go/ql/lib/printAst.ql

@@ -12,12 +12,12 @@ import semmle.go.PrintAst
 import ideContextual
 
 /**
- * The source file to generate an AST from.
+ * Gets the source file to generate an AST from.
  */
 external string selectedSourceFile();
 
 /**
- * Hook to customize the functions printed by this query.
+ * A hook to customize the functions printed by this query.
  */
 class Cfg extends PrintAstConfiguration {
   override predicate shouldPrintFunction(FuncDecl func) { shouldPrintFile(func.getFile()) }

go/ql/lib/semmle/go/Concepts.qll

@@ -115,7 +115,7 @@ module FileSystemAccess {
 /** A function that escapes meta-characters to prevent injection attacks. */
 class EscapeFunction extends Function instanceof EscapeFunction::Range {
   /**
-   * The context that this function escapes for.
+   * Gets the context that this function escapes for.
    *
    * Currently, this can be "js", "html", or "url".
    */
@@ -132,7 +132,7 @@ module EscapeFunction {
    */
   abstract class Range extends Function {
     /**
-     * The context that this function escapes for.
+     * Gets the context that this function escapes for.
      *
      * Currently, this can be `js', `html', or `url'.
      */

go/ql/lib/semmle/go/Files.qll

@@ -181,7 +181,7 @@ class Folder extends Container, @folder {
   override string getURL() { result = "folder://" + this.getAbsolutePath() }
 }
 
-/** Any file, including files that have not been extracted but are referred to as locations for errors. */
+/** A file, including files that have not been extracted but are referred to as locations for errors. */
 class ExtractedOrExternalFile extends Container, @file, Documentable, ExprParent, GoModExprParent,
   DeclParent, ScopeNode
 {

go/ql/lib/semmle/go/PrintAst.ql

@@ -9,7 +9,7 @@ import go
 import PrintAst
 
 /**
- * Hook to customize the functions printed by this query.
+ * A hook to customize the functions printed by this query.
  */
 class Cfg extends PrintAstConfiguration {
   override predicate shouldPrintFunction(FuncDecl func) { any() }

go/ql/lib/semmle/go/PrintAst.qll

@@ -5,7 +5,7 @@
 import go
 
 /**
- * Hook to customize the files and functions printed by this module.
+ * A hook to customize the files and functions printed by this module.
  *
  * For an AstNode to be printed, it always requires `shouldPrintFile(f)` to hold
  * for its containing file `f`, and additionally requires `shouldPrintFunction(fun)`

go/ql/lib/semmle/go/Scopes.qll

@@ -602,7 +602,7 @@ private newtype TCallable =
   TFuncLitCallable(FuncLit l)
 
 /**
- * This is either a `Function` or a `FuncLit`, because of limitations of both
+ * A `Function` or a `FuncLit`. We do it this way because of limitations of both
  * `Function` and `FuncDef`:
  *   - `Function` is an entity, and therefore does not include function literals, and
  *   - `FuncDef` is an AST node, and so is not extracted for functions from external libraries.

go/ql/lib/semmle/go/StringOps.qll

@@ -581,7 +581,7 @@ module StringOps {
   }
 
   /**
-   * One of the operands in a string concatenation.
+   * An operand in a string concatenation.
    *
    * See `ConcatenationElement` for more information.
    */

go/ql/lib/semmle/go/Types.qll

@@ -172,7 +172,7 @@ class InvalidType extends @invalidtype, Type {
 /** A basic type. */
 class BasicType extends @basictype, Type { }
 
-/** Either the normal or literal boolean type */
+/** The normal boolean type or the literal boolean type */
 class BoolType extends @booltype, BasicType { }
 
 /** The `bool` type of a non-literal expression */
@@ -317,7 +317,7 @@ class Complex128Type extends @complex128type, ComplexType {
   override string getName() { result = "complex128" }
 }
 
-/** Either the normal or literal string type */
+/** The normal string type or the literal string type */
 class StringType extends @stringtype, BasicType { }
 
 /** The `string` type of a non-literal expression */

go/ql/lib/semmle/go/dataflow/barrierguardutil/RegexpCheck.qll

@@ -5,7 +5,7 @@
 import go
 
 /**
- * A call to a regexp match function, considered as a barrier guard for sanitizing untrusted URLs.
+ * Holds if `resultNode` comes from a call to a regexp match function, considered as a barrier guard for sanitizing untrusted URLs.
  *
  * This is overapproximate: we do not attempt to reason about the correctness of the regexp.
  *

go/ql/lib/semmle/go/security/InsecureFeatureFlag.qll

@@ -71,7 +71,7 @@ module InsecureFeatureFlag {
   }
 
   /**
-   * Flags suggesting an optional feature, perhaps deliberately insecure.
+   * A flag suggesting an optional feature, perhaps deliberately insecure.
    */
   class SecurityFeatureFlag extends FlagKind {
     SecurityFeatureFlag() { this = "securityFeature" }