hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-20 18:56:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

Java: Fix QLDoc for Container.toString()

Browse Source 
Fixes #5828

The QLDoc was just too specific about the default implementation. I've improved the wording.
This commit is contained in:
Dave Bartolomeo
2021-05-08 11:14:02 -04:00
parent 65ac5b862d
commit d9f243d18a
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
java/ql/src/semmle/code/FileSystem.qll
View File

@@ -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() }
}