Swift: change doc of Immediate property getters

Author: redsun82

swift/codegen/templates/ql_class.mustache

@@ -60,7 +60,8 @@ module Generated {
     {{#type_is_class}}
     /**
      * {{>ql_property_doc}}     *
-     * This includes nodes from the "hidden" AST.
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behaviour of both the `Immediate` and non-`Immediate` versions.
      */
     {{type}} getImmediate{{singular}}({{#is_repeated}}int index{{/is_repeated}}) {
       {{^ipa}}

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

@@ -10,7 +10,8 @@ module Generated {
     /**
      * Gets the self parameter of this callable, if it exists.
      *
-     * This includes nodes from the "hidden" AST.
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behaviour of both the `Immediate` and non-`Immediate` versions.
      */
     ParamDecl getImmediateSelfParam() {
       result =
@@ -32,7 +33,8 @@ module Generated {
     /**
      * Gets the `index`th parameter of this callable (0-based).
      *
-     * This includes nodes from the "hidden" AST.
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behaviour of both the `Immediate` and non-`Immediate` versions.
      */
     ParamDecl getImmediateParam(int index) {
       result =
@@ -59,7 +61,8 @@ module Generated {
     /**
      * Gets the body of this callable, if it exists.
      *
-     * This includes nodes from the "hidden" AST.
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behaviour of both the `Immediate` and non-`Immediate` versions.
      */
     BraceStmt getImmediateBody() {
       result =

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

@@ -9,7 +9,8 @@ module Generated {
     /**
      * Gets the location associated with this element in the code, if it exists.
      *
-     * This includes nodes from the "hidden" AST.
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behaviour of both the `Immediate` and non-`Immediate` versions.
      */
     Location getImmediateLocation() {
       result =

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

@@ -9,7 +9,8 @@ module Generated {
     /**
      * Gets the file of this location.
      *
-     * This includes nodes from the "hidden" AST.
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behaviour of both the `Immediate` and non-`Immediate` versions.
      */
     File getImmediateFile() {
       result =

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

@@ -9,7 +9,8 @@ module Generated {
     /**
      * Gets the `index`th accessor declaration of this abstract storage declaration (0-based).
      *
-     * This includes nodes from the "hidden" AST.
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behaviour of both the `Immediate` and non-`Immediate` versions.
      */
     AccessorDecl getImmediateAccessorDecl(int index) {
       result =

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

@@ -9,7 +9,8 @@ module Generated {
     /**
      * Gets the module of this declaration.
      *
-     * This includes nodes from the "hidden" AST.
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behaviour of both the `Immediate` and non-`Immediate` versions.
      */
     ModuleDecl getImmediateModule() {
       result =

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

@@ -11,7 +11,8 @@ module Generated {
     /**
      * Gets the `index`th element of this enum case declaration (0-based).
      *
-     * This includes nodes from the "hidden" AST.
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behaviour of both the `Immediate` and non-`Immediate` versions.
      */
     EnumElementDecl getImmediateElement(int index) {
       result =

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

@@ -18,7 +18,8 @@ module Generated {
     /**
      * Gets the `index`th parameter of this enum element declaration (0-based).
      *
-     * This includes nodes from the "hidden" AST.
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behaviour of both the `Immediate` and non-`Immediate` versions.
      */
     ParamDecl getImmediateParam(int index) {
       result =

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

@@ -13,7 +13,8 @@ module Generated {
     /**
      * Gets the extended type declaration of this extension declaration.
      *
-     * This includes nodes from the "hidden" AST.
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behaviour of both the `Immediate` and non-`Immediate` versions.
      */
     NominalTypeDecl getImmediateExtendedTypeDecl() {
       result =

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

@@ -9,7 +9,8 @@ module Generated {
     /**
      * Gets the `index`th generic type parameter of this generic context (0-based).
      *
-     * This includes nodes from the "hidden" AST.
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behaviour of both the `Immediate` and non-`Immediate` versions.
      */
     GenericTypeParamDecl getImmediateGenericTypeParam(int index) {
       result =