Python: Add a bunch more toString docs.

Author: tausbn

python/ql/src/Lexical/CommentedOutCode.qll

@@ -175,6 +175,7 @@ class CommentedOutCodeLine extends Comment {
 class CommentedOutCodeBlock extends @py_comment {
     CommentedOutCodeBlock() { commented_out_code_block(this, _) }
 
+    /** Gets a textual representation of this element. */
     string toString() { result = "Commented out code" }
 
     /** Whether this commented-out code block contains the comment c */

python/ql/src/analysis/DefinitionTracking.qll

@@ -10,6 +10,7 @@ private newtype TDefinition =
 
 /** A definition for the purposes of jump-to-definition. */
 class Definition extends TLocalDefinition {
+    /** Gets a textual representation of this element. */
     string toString() { result = "Definition " + this.getAstNode().getLocation().toString() }
 
     AstNode getAstNode() { this = TLocalDefinition(result) }
@@ -467,6 +468,7 @@ Definition getUniqueDefinition(Expr use) {
 
 /** Helper class to get suitable locations for attributes */
 class NiceLocationExpr extends @py_expr {
+    /** Gets a textual representation of this element. */
     string toString() { result = this.(Expr).toString() }
     /**
      * Holds if this element is at the specified location.

python/ql/src/external/ExternalArtifact.qll

@@ -18,6 +18,7 @@ class ExternalDefect extends @externalDefect {
 
     Location getLocation() { externalDefects(this, _, result, _, _) }
 
+    /** Gets a textual representation of this element. */
     string toString() { result = getQueryPath() + ": " + getLocation() + " - " + getMessage() }
 }
 
@@ -28,6 +29,7 @@ class ExternalMetric extends @externalMetric {
 
     Location getLocation() { externalMetrics(this, _, result, _) }
 
+    /** Gets a textual representation of this element. */
     string toString() { result = getQueryPath() + ": " + getLocation() + " - " + getValue() }
 }
 

python/ql/src/external/VCS.qll

@@ -10,6 +10,7 @@ class Commit extends @svnentry {
         )
     }
 
+    /** Gets a textual representation of this element. */
     string toString() { result = this.getRevisionName() }
 
     string getRevisionName() { svnentries(this, result, _, _, _) }

python/ql/src/semmle/python/Comment.qll

@@ -14,6 +14,7 @@ class Comment extends @py_comment {
 
     Location getLocation() { py_comments(this, _, result) }
 
+    /** Gets a textual representation of this element. */
     string toString() { result = "Comment " + this.getText() }
 
     /**
@@ -55,6 +56,7 @@ class CommentBlock extends @py_comment {
 
     private Comment last() { comment_block_part(this, result, this.length()) }
 
+    /** Gets a textual representation of this element. */
     string toString() { result = "Comment block" }
 
     /** The length of this comment block (in comments) */

python/ql/src/semmle/python/Exprs.qll

@@ -7,6 +7,7 @@ class Expr extends Expr_, AstNode {
     /** Gets the scope of this expression */
     override Scope getScope() { py_scopes(this, result) }
 
+    /** Gets a textual representation of this element. */
     override string toString() { result = "Expression" }
 
     /** Gets the module in which this expression occurs */

python/ql/src/semmle/python/Files.qll

@@ -393,6 +393,7 @@ class Location extends @location {
         locations_ast(this, _, _, _, _, result)
     }
 
+    /** Gets a textual representation of this element. */
     string toString() {
         result = this.getPath().getAbsolutePath() + ":" + this.getStartLine().toString()
     }
@@ -433,6 +434,7 @@ class Line extends @py_line {
         )
     }
 
+    /** Gets a textual representation of this element. */
     string toString() {
         exists(Module m | py_line_lengths(this, m, _, _) |
             result = m.getFile().getShortName() + ":" + this.getLineNumber().toString()

python/ql/src/semmle/python/Flow.qll

@@ -139,6 +139,7 @@ class ControlFlowNode extends @py_flow_node {
     /** Gets the syntactic element corresponding to this flow node */
     AstNode getNode() { py_flow_bb_node(this, result, _, _) }
 
+    /** Gets a textual representation of this element. */
     string toString() {
         exists(Scope s | s.getEntryNode() = this | result = "Entry node for " + s.toString())
         or
@@ -1014,6 +1015,7 @@ class BasicBlock extends @py_flow_node {
     /** Gets the nth node in this basic block */
     ControlFlowNode getNode(int n) { py_flow_bb_node(result, _, this, n) }
 
+    /** Gets a textual representation of this element. */
     string toString() { result = "BasicBlock" }
 
     /** Whether this basic block strictly dominates the other */

python/ql/src/semmle/python/SSA.qll

@@ -76,6 +76,7 @@ class SsaVariable extends @py_ssa_var {
         result = this.getAPhiInput().getAnUltimateDefinition()
     }
 
+    /** Gets a textual representation of this element. */
     string toString() { result = "SSA Variable " + this.getId() }
 
     Location getLocation() { result = this.getDefinition().getLocation() }

python/ql/src/semmle/python/Variables.qll

@@ -13,6 +13,7 @@ class Variable extends @py_variable {
     /** Gets the identifier (name) of this variable */
     string getId() { variable(this, _, result) }
 
+    /** Gets a textual representation of this element. */
     string toString() { result = "Variable " + this.getId() }
 
     /** Gets an access (load or store) of this variable */