Swift: property doc tweaks

Author: redsun82

swift/codegen/templates/ql_class.mustache

@@ -59,8 +59,7 @@ module Generated {
 
     {{#type_is_class}}
     /**
-     * Gets the {{#is_repeated}}`index`th {{/is_repeated}}{{doc_name}}{{#is_optional}}, if it exists{{/is_optional}}.
-     * This is taken from the "hidden" AST and should only be used to be overridden by classes.
+     * {{>ql_property_doc}}     * This includes nodes from the "hidden" AST and can be used to be overridden by subclasses.
      */
     {{type}} getImmediate{{singular}}({{#is_repeated}}int index{{/is_repeated}}) {
       {{^ipa}}
@@ -72,11 +71,7 @@ module Generated {
     }
 
     /**
-     * Gets the {{#is_repeated}}`index`th {{/is_repeated}}{{doc_name}}{{#is_optional}}, if it exists{{/is_optional}}.
-    {{#has_doc}}
-     *
-    {{#doc}}
-     * {{.}}
+     * {{>ql_property_doc}}{{#has_doc}}{{#doc}}     * {{.}}
     {{/doc}}
     {{/has_doc}}
      */
@@ -88,11 +83,7 @@ module Generated {
     {{^type_is_class}}
     {{^is_predicate}}
     /**
-     * Gets the {{#is_repeated}}`index`th {{/is_repeated}}{{doc_name}}{{#is_optional}}, if it exists{{/is_optional}}.
-    {{#has_doc}}
-     *
-    {{#doc}}
-     * {{.}}
+     * {{>ql_property_doc}}{{#has_doc}}{{#doc}}     * {{.}}
     {{/doc}}
     {{/has_doc}}
      */

swift/codegen/templates/ql_property_doc.mustache

@@ -0,0 +1 @@
+Gets the {{#is_repeated}}`index`th {{/is_repeated}}{{doc_name}}{{#is_repeated}} (0-based){{/is_repeated}}{{#is_optional}}, if it exists{{/is_optional}}.

swift/ql/lib/codeql/swift/generated/Callable.qll

@@ -9,7 +9,7 @@ module Generated {
   class Callable extends Synth::TCallable, Element {
     /**
      * Gets the self param, if it exists.
-     * This is taken from the "hidden" AST and should only be used to be overridden by classes.
+     * This includes nodes from the "hidden" AST and can be used to be overridden by subclasses.
      */
     ParamDecl getImmediateSelfParam() {
       result =
@@ -29,8 +29,8 @@ module Generated {
     final predicate hasSelfParam() { exists(getSelfParam()) }
 
     /**
-     * Gets the `index`th param.
-     * This is taken from the "hidden" AST and should only be used to be overridden by classes.
+     * Gets the `index`th param (0-based).
+     * This includes nodes from the "hidden" AST and can be used to be overridden by subclasses.
      */
     ParamDecl getImmediateParam(int index) {
       result =
@@ -40,7 +40,7 @@ module Generated {
     }
 
     /**
-     * Gets the `index`th param.
+     * Gets the `index`th param (0-based).
      */
     final ParamDecl getParam(int index) { result = getImmediateParam(index).resolve() }
 
@@ -56,7 +56,7 @@ module Generated {
 
     /**
      * Gets the body, if it exists.
-     * This is taken from the "hidden" AST and should only be used to be overridden by classes.
+     * This includes nodes from the "hidden" AST and can be used to be overridden by subclasses.
      */
     BraceStmt getImmediateBody() {
       result =
@@ -65,7 +65,6 @@ module Generated {
 
     /**
      * Gets the body, if it exists.
-     *
      * The body is absent within protocol declarations.
      */
     final BraceStmt getBody() { result = getImmediateBody().resolve() }

swift/ql/lib/codeql/swift/generated/Locatable.qll

@@ -8,7 +8,7 @@ module Generated {
   class Locatable extends Synth::TLocatable, Element {
     /**
      * Gets the location, if it exists.
-     * This is taken from the "hidden" AST and should only be used to be overridden by classes.
+     * This includes nodes from the "hidden" AST and can be used to be overridden by subclasses.
      */
     Location getImmediateLocation() {
       result =

swift/ql/lib/codeql/swift/generated/Location.qll

@@ -8,7 +8,7 @@ module Generated {
   class Location extends Synth::TLocation, Element {
     /**
      * Gets the file.
-     * This is taken from the "hidden" AST and should only be used to be overridden by classes.
+     * This includes nodes from the "hidden" AST and can be used to be overridden by subclasses.
      */
     File getImmediateFile() {
       result =

swift/ql/lib/codeql/swift/generated/decl/AbstractStorageDecl.qll

@@ -7,8 +7,8 @@ import codeql.swift.elements.decl.ValueDecl
 module Generated {
   class AbstractStorageDecl extends Synth::TAbstractStorageDecl, ValueDecl {
     /**
-     * Gets the `index`th accessor decl.
-     * This is taken from the "hidden" AST and should only be used to be overridden by classes.
+     * Gets the `index`th accessor decl (0-based).
+     * This includes nodes from the "hidden" AST and can be used to be overridden by subclasses.
      */
     AccessorDecl getImmediateAccessorDecl(int index) {
       result =
@@ -18,7 +18,7 @@ module Generated {
     }
 
     /**
-     * Gets the `index`th accessor decl.
+     * Gets the `index`th accessor decl (0-based).
      */
     final AccessorDecl getAccessorDecl(int index) {
       result = getImmediateAccessorDecl(index).resolve()

swift/ql/lib/codeql/swift/generated/decl/Decl.qll

@@ -8,7 +8,7 @@ module Generated {
   class Decl extends Synth::TDecl, AstNode {
     /**
      * Gets the module.
-     * This is taken from the "hidden" AST and should only be used to be overridden by classes.
+     * This includes nodes from the "hidden" AST and can be used to be overridden by subclasses.
      */
     ModuleDecl getImmediateModule() {
       result =

swift/ql/lib/codeql/swift/generated/decl/EnumCaseDecl.qll

@@ -9,8 +9,8 @@ module Generated {
     override string getAPrimaryQlClass() { result = "EnumCaseDecl" }
 
     /**
-     * Gets the `index`th element.
-     * This is taken from the "hidden" AST and should only be used to be overridden by classes.
+     * Gets the `index`th element (0-based).
+     * This includes nodes from the "hidden" AST and can be used to be overridden by subclasses.
      */
     EnumElementDecl getImmediateElement(int index) {
       result =
@@ -20,7 +20,7 @@ module Generated {
     }
 
     /**
-     * Gets the `index`th element.
+     * Gets the `index`th element (0-based).
      */
     final EnumElementDecl getElement(int index) { result = getImmediateElement(index).resolve() }
 

swift/ql/lib/codeql/swift/generated/decl/EnumElementDecl.qll

@@ -16,8 +16,8 @@ module Generated {
     }
 
     /**
-     * Gets the `index`th param.
-     * This is taken from the "hidden" AST and should only be used to be overridden by classes.
+     * Gets the `index`th param (0-based).
+     * This includes nodes from the "hidden" AST and can be used to be overridden by subclasses.
      */
     ParamDecl getImmediateParam(int index) {
       result =
@@ -27,7 +27,7 @@ module Generated {
     }
 
     /**
-     * Gets the `index`th param.
+     * Gets the `index`th param (0-based).
      */
     final ParamDecl getParam(int index) { result = getImmediateParam(index).resolve() }
 

swift/ql/lib/codeql/swift/generated/decl/ExtensionDecl.qll

@@ -12,7 +12,7 @@ module Generated {
 
     /**
      * Gets the extended type decl.
-     * This is taken from the "hidden" AST and should only be used to be overridden by classes.
+     * This includes nodes from the "hidden" AST and can be used to be overridden by subclasses.
      */
     NominalTypeDecl getImmediateExtendedTypeDecl() {
       result =