Python: add missing qldoc

yoff · yoff · commit 3ee756694f8d · 2022-11-14T16:45:22.000+01:00
also add to ordinary `except`
diff --git a/python/ql/lib/semmle/python/essa/Essa.qll b/python/ql/lib/semmle/python/essa/Essa.qll
@@ -517,6 +517,10 @@ class ExceptionCapture extends EssaNodeDefinition {
     SsaSource::exception_capture(this.getSourceVariable(), this.getDefiningNode())
   }
 
+  /**
+   * Gets the type handled by this exception handler
+   * `ExceptionType` in `except ExceptionType as ex:`.
+   */
   ControlFlowNode getType() {
     exists(ExceptGroupFlowNode ex |
       ex.getName() = this.getDefiningNode() and
@@ -535,6 +539,10 @@ class ExceptionGroupCapture extends EssaNodeDefinition {
     SsaSource::exception_group_capture(this.getSourceVariable(), this.getDefiningNode())
   }
 
+  /**
+   * Gets the type handled by this exception handler
+   * `ExceptionType` in `except* ExceptionType as ex:`.
+   */
   ControlFlowNode getType() {
     exists(ExceptGroupFlowNode ex |
       ex.getName() = this.getDefiningNode() and
diff --git a/python/ql/lib/semmle/python/types/Exceptions.qll b/python/ql/lib/semmle/python/types/Exceptions.qll
@@ -367,6 +367,10 @@ predicate scope_raises_unknown(Scope s) {
 class ExceptFlowNode extends ControlFlowNode {
   ExceptFlowNode() { this.getNode() instanceof ExceptStmt }
 
+  /**
+   * Gets the type handled by this exception handler.
+   * `ExceptionType` in `except ExceptionType as e:`
+   */
   ControlFlowNode getType() {
     exists(ExceptStmt ex |
       this.getBasicBlock().dominates(result.getBasicBlock()) and
@@ -375,6 +379,10 @@ class ExceptFlowNode extends ControlFlowNode {
     )
   }
 
+  /**
+   * Gets the name assigned to the handled exception, if any.
+   * `e` in `except ExceptionType as e:`
+   */
   ControlFlowNode getName() {
     exists(ExceptStmt ex |
       this.getBasicBlock().dominates(result.getBasicBlock()) and
@@ -443,11 +451,19 @@ class ExceptFlowNode extends ControlFlowNode {
 class ExceptGroupFlowNode extends ControlFlowNode {
   ExceptGroupFlowNode() { this.getNode() instanceof ExceptGroupStmt }
 
+  /**
+   * Gets the type handled by this exception handler.
+   * `eg` in `except* eg as e:`
+   */
   ControlFlowNode getType() {
     this.getBasicBlock().dominates(result.getBasicBlock()) and
     result = this.getNode().(ExceptGroupStmt).getType().getAFlowNode()
   }
 
+  /**
+   * Gets the name assigned to the handled exception, if any.
+   * `e` in `except* eg as e:`
+   */
   ControlFlowNode getName() {
     this.getBasicBlock().dominates(result.getBasicBlock()) and
     result = this.getNode().(ExceptGroupStmt).getName().getAFlowNode()
