add missing qldoc

erik-krogh · erik-krogh · commit 7530923af3d6 · 2022-05-04T16:14:59.000+02:00
diff --git a/javascript/ql/lib/semmle/javascript/Actions.qll b/javascript/ql/lib/semmle/javascript/Actions.qll
@@ -21,6 +21,8 @@ module Actions {
   }
 
   /**
+   * A YAML node that may contain sub-nodes.
+   *
    * Actions are quite flexible in parsing YAML.
    *
    * For example:
@@ -48,6 +50,7 @@ module Actions {
       this instanceof YAMLScalar
     }
 
+    /** Gets sub-name identified by `name`. */
     YAMLNode getNode(string name) {
       exists(YAMLMapping mapping |
         mapping = this and
@@ -68,6 +71,7 @@ module Actions {
       )
     }
 
+    /** Gets the number of elements in this mapping or sequence. */
     int getElementCount() {
       exists(YAMLMapping mapping |
         mapping = this and
@@ -113,6 +117,7 @@ module Actions {
 
     On() { workflow.lookup("on") = this }
 
+    /** Gets the workflow that this trigger is in. */
     Workflow getWorkflow() { result = workflow }
   }
 
@@ -283,6 +288,7 @@ module Actions {
 
     Ref() { with.lookup("ref") = this }
 
+    /** Gets the `with` field this field belongs to. */
     With getWith() { result = with }
   }
 

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ module Actions {`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`/**`
	`24`	`+ * A YAML node that may contain sub-nodes.`
	`25`	`+ *`
`24`	`26`	`* Actions are quite flexible in parsing YAML.`
`25`	`27`	`*`
`26`	`28`	`* For example:`
`@@ -48,6 +50,7 @@ module Actions {`
`48`	`50`	`this instanceof YAMLScalar`
`49`	`51`	`}`
`50`	`52`
	`53`	+ /** Gets sub-name identified by `name`. */
`51`	`54`	`YAMLNode getNode(string name) {`
`52`	`55`	`exists(YAMLMapping mapping \|`
`53`	`56`	`mapping = this and`
`@@ -68,6 +71,7 @@ module Actions {`
`68`	`71`	`)`
`69`	`72`	`}`
`70`	`73`
	`74`	`+ /** Gets the number of elements in this mapping or sequence. */`
`71`	`75`	`int getElementCount() {`
`72`	`76`	`exists(YAMLMapping mapping \|`
`73`	`77`	`mapping = this and`
`@@ -113,6 +117,7 @@ module Actions {`
`113`	`117`
`114`	`118`	`On() { workflow.lookup("on") = this }`
`115`	`119`
	`120`	`+ /** Gets the workflow that this trigger is in. */`
`116`	`121`	`Workflow getWorkflow() { result = workflow }`
`117`	`122`	`}`
`118`	`123`
`@@ -283,6 +288,7 @@ module Actions {`
`283`	`288`
`284`	`289`	`Ref() { with.lookup("ref") = this }`
`285`	`290`
	`291`	+ /** Gets the `with` field this field belongs to. */
`286`	`292`	`With getWith() { result = with }`
`287`	`293`	`}`
`288`	`294`