Merge pull request github#5857 from dbartol/container/work

aschackmull · web-flow · commit 7d6a49713647 · 2021-05-11T08:37:41.000+02:00
Java: Fix QLDoc for `Container.toString()`
diff --git a/java/ql/src/semmle/code/FileSystem.qll b/java/ql/src/semmle/code/FileSystem.qll
@@ -146,9 +146,11 @@ class Container extends @container, Top {
   }
 
   /**
-   * Gets a textual representation of the path of this container.
+   * Gets a textual representation of this container.
    *
-   * This is the absolute path of the container.
+   * The default implementation gets the absolute path to the container, but subclasses may override
+   * to provide a different result. To get the absolute path of any `Container`, call
+   * `Container.getAbsolutePath()` directly.
    */
   override string toString() { result = getAbsolutePath() }
 }

Original file line number	Diff line number	Diff line change
`@@ -146,9 +146,11 @@ class Container extends @container, Top {`
`146`	`146`	`}`
`147`	`147`
`148`	`148`	`/**`
`149`		`- * Gets a textual representation of the path of this container.`
	`149`	`+ * Gets a textual representation of this container.`
`150`	`150`	`*`
`151`		`- * This is the absolute path of the container.`
	`151`	`+ * The default implementation gets the absolute path to the container, but subclasses may override`
	`152`	+ * to provide a different result. To get the absolute path of any `Container`, call
	`153`	+ * `Container.getAbsolutePath()` directly.
`152`	`154`	`*/`
`153`	`155`	`override string toString() { result = getAbsolutePath() }`
`154`	`156`	`}`