Add some more QL docs

github · Sep 13, 2024 · e682298 · e682298
1 parent 5c02fb4
commit e682298
Show file tree

Hide file tree

Showing 9 changed files with 31 additions and 7 deletions.
diff --git a/rust/ql/.generated.list b/rust/ql/.generated.list
diff --git a/rust/ql/lib/codeql/rust/elements/Declaration.qll b/rust/ql/lib/codeql/rust/elements/Declaration.qll
diff --git a/rust/ql/lib/codeql/rust/elements/Unimplemented.qll b/rust/ql/lib/codeql/rust/elements/Unimplemented.qll
diff --git a/rust/ql/lib/codeql/rust/elements/UnimplementedDeclaration.qll b/rust/ql/lib/codeql/rust/elements/UnimplementedDeclaration.qll
diff --git a/rust/ql/lib/codeql/rust/generated/Declaration.qll b/rust/ql/lib/codeql/rust/generated/Declaration.qll
diff --git a/rust/ql/lib/codeql/rust/generated/Raw.qll b/rust/ql/lib/codeql/rust/generated/Raw.qll
diff --git a/rust/ql/lib/codeql/rust/generated/Unimplemented.qll b/rust/ql/lib/codeql/rust/generated/Unimplemented.qll
diff --git a/rust/ql/lib/codeql/rust/generated/UnimplementedDeclaration.qll b/rust/ql/lib/codeql/rust/generated/UnimplementedDeclaration.qll
diff --git a/rust/schema.py b/rust/schema.py
@@ -64,15 +64,24 @@ class AstNode(Locatable):
 
 @qltest.skip
 class Unimplemented(Element):
+    """
+    The base class for unimplemented nodes. This is used to mark nodes that are not yet extracted.
+    """
     pass
 
 
 class Declaration(AstNode):
+    """
+    The base class for declarations.
+    """
     pass
 
 
 @qltest.skip
 class UnimplementedDeclaration(Declaration, Unimplemented):
+    """
+    A declaration that is not yet extracted.
+    """
     pass