Merge pull request #3807 from geoffw0/qldoc3

C++: Even more QLDoc

cpp/ql/src/semmle/code/cpp/Parameter.qll

@@ -1,3 +1,7 @@
+/**
+ * Provides a class that models parameters to functions.
+ */
+
 import semmle.code.cpp.Location
 import semmle.code.cpp.Declaration
 private import semmle.code.cpp.internal.ResolveClass

cpp/ql/src/semmle/code/cpp/Specifier.qll

@@ -1,3 +1,7 @@
+/**
+ * Provides classes for modeling specifiers and attributes.
+ */
+
 import semmle.code.cpp.Element
 private import semmle.code.cpp.internal.ResolveClass
 

cpp/ql/src/semmle/code/cpp/Struct.qll

@@ -1,3 +1,7 @@
+/**
+ * Provides classes for modeling `struct`s.
+ */
+
 import semmle.code.cpp.Type
 import semmle.code.cpp.Class
 

cpp/ql/src/semmle/code/cpp/TypedefType.qll

@@ -1,3 +1,7 @@
+/**
+ * Provides classes for modeling typedefs and type aliases.
+ */
+
 import semmle.code.cpp.Type
 private import semmle.code.cpp.internal.ResolveClass
 

cpp/ql/src/semmle/code/cpp/Union.qll

@@ -1,3 +1,7 @@
+/**
+ * Provides classes for modeling `union`s.
+ */
+
 import semmle.code.cpp.Type
 import semmle.code.cpp.Struct
 

cpp/ql/src/semmle/code/cpp/UserType.qll

@@ -1,3 +1,8 @@
+/**
+ * Provides classes for modeling user-defined types such as classes, typedefs
+ * and enums.
+ */
+
 import semmle.code.cpp.Declaration
 import semmle.code.cpp.Type
 import semmle.code.cpp.Function
@@ -83,6 +88,9 @@ class UserType extends Type, Declaration, NameQualifyingElement, AccessHolder, @
    * type exactly - but this is not apparent from its subclasses
    */
 
+  /**
+   * Gets a child declaration within this user-defined type.
+   */
   Declaration getADeclaration() { none() }
 
   override string explain() { result = this.getName() }

cpp/ql/src/semmle/code/cpp/Variable.qll

@@ -1,3 +1,7 @@
+/**
+ * Provides classes for modeling variables and their declarations.
+ */
+
 import semmle.code.cpp.Element
 import semmle.code.cpp.exprs.Access
 import semmle.code.cpp.Initializer

cpp/ql/src/semmle/code/cpp/commons/File.qll

@@ -1,3 +1,7 @@
+/**
+ * Provides predicates for identifying function calls that open or close a file.
+ */
+
 import cpp
 
 /**

cpp/ql/src/semmle/code/cpp/security/SecurityOptions.qll

@@ -1,4 +1,4 @@
-/*
+/**
  * Security pack options.
  *
  * see https://semmle.com/wiki/display/SD/_Configuring+SecurityOptions+for+your+code+base
@@ -9,6 +9,10 @@
 
 import semmle.code.cpp.security.Security
 
+/**
+ * This class overrides `SecurityOptions` and can be used to add project
+ * specific customization.
+ */
 class CustomSecurityOptions extends SecurityOptions {
   override predicate sqlArgument(string function, int arg) {
     SecurityOptions.super.sqlArgument(function, arg)