Add documentation to main classes' functions.

jorgectf · RasmusWL · web-flow · commit c2b96b3a5e8e · 2021-05-07T21:51:10.000+02:00
Co-authored-by: Rasmus Wriedt Larsen &lt;rasmuswriedtlarsen@gmail.com&gt;
diff --git a/python/ql/src/experimental/semmle/python/Concepts.qll b/python/ql/src/experimental/semmle/python/Concepts.qll
@@ -41,6 +41,9 @@ class LDAPQuery extends DataFlow::Node {
 
   LDAPQuery() { this = range }
 
+  /**
+   * Gets the argument containing the executed expression.
+   */
   DataFlow::Node getLDAPNode() { result = range.getLDAPNode() }
 }
 
@@ -71,5 +74,8 @@ class LDAPEscape extends DataFlow::Node {
 
   LDAPEscape() { this = range }
 
+  /**
+   * Gets the argument containing the escaped expression.
+   */
   DataFlow::Node getEscapeNode() { result = range.getEscapeNode() }
 }

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,9 @@ class LDAPQuery extends DataFlow::Node {`
`41`	`41`
`42`	`42`	`LDAPQuery() { this = range }`
`43`	`43`
	`44`	`+ /**`
	`45`	`+ * Gets the argument containing the executed expression.`
	`46`	`+ */`
`44`	`47`	`DataFlow::Node getLDAPNode() { result = range.getLDAPNode() }`
`45`	`48`	`}`
`46`	`49`
`@@ -71,5 +74,8 @@ class LDAPEscape extends DataFlow::Node {`
`71`	`74`
`72`	`75`	`LDAPEscape() { this = range }`
`73`	`76`
	`77`	`+ /**`
	`78`	`+ * Gets the argument containing the escaped expression.`
	`79`	`+ */`
`74`	`80`	`DataFlow::Node getEscapeNode() { result = range.getEscapeNode() }`
`75`	`81`	`}`