Add QLDoc

owen-mc · owen-mc · commit 1318504aa579 · 2024-10-17T12:06:46.000+01:00
diff --git a/go/ql/lib/semmle/go/Types.qll b/go/ql/lib/semmle/go/Types.qll
@@ -638,6 +638,9 @@ class PointerType extends @pointertype, CompositeType {
   override string toString() { result = "pointer type" }
 }
 
+/**
+ * Gets the base type if `t` is a pointer type, otherwise `t` itself.
+ */
 Type lookThroughPointerType(Type t) {
   not t instanceof PointerType and
   result = t

Original file line number	Diff line number	Diff line change
`@@ -638,6 +638,9 @@ class PointerType extends @pointertype, CompositeType {`
`638`	`638`	`override string toString() { result = "pointer type" }`
`639`	`639`	`}`
`640`	`640`
	`641`	`+/**`
	`642`	+ * Gets the base type if `t` is a pointer type, otherwise `t` itself.
	`643`	`+ */`
`641`	`644`	`Type lookThroughPointerType(Type t) {`
`642`	`645`	`not t instanceof PointerType and`
`643`	`646`	`result = t`