Java: Fix QLDoc for Container.toString()

Dave Bartolomeo · Dave Bartolomeo · commit d9f243d18a48 · 2021-05-08T11:14:02.000-04:00
Fixes github#5828 The QLDoc was just too specific about the default implementation. I've improved the wording.
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 returns the absolute path to the container, but subclasses may
+   * may override to provide a different result. To get the absolute path for 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 returns the absolute path to the container, but subclasses may`
	`152`	+ * may override to provide a different result. To get the absolute path for any `Container`, call
	`153`	+ * `Container.getAbsolutePath()` directly.
`152`	`154`	`*/`
`153`	`155`	`override string toString() { result = getAbsolutePath() }`
`154`	`156`	`}`