C++: expand qldoc on MemberFunction::getTypeOfThis()

nickrolfe · nickrolfe · commit ab1dc64eeae1 · 2020-06-29T11:54:28.000+01:00
diff --git a/cpp/ql/src/semmle/code/cpp/MemberFunction.qll b/cpp/ql/src/semmle/code/cpp/MemberFunction.qll
@@ -72,7 +72,8 @@ class MemberFunction extends Function {
   }
 
   /**
-   * Gets the type of the `this` parameter associated with this member function, if any.
+   * Gets the type of the `this` parameter associated with this member function, if any. Typically,
+   * this will be a `PointerType`, possibly with `const` and/or `volatile` qualifiers.
    */
   Type getTypeOfThis() {
     member_function_this_type(underlyingElement(this), unresolveElement(result))

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,8 @@ class MemberFunction extends Function {`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`/**`
`75`		- * Gets the type of the `this` parameter associated with this member function, if any.
	`75`	+ * Gets the type of the `this` parameter associated with this member function, if any. Typically,
	`76`	+ * this will be a `PointerType`, possibly with `const` and/or `volatile` qualifiers.
`76`	`77`	`*/`
`77`	`78`	`Type getTypeOfThis() {`
`78`	`79`	`member_function_this_type(underlyingElement(this), unresolveElement(result))`