Class Documentable
A program element to which a documentation comment group may be attached: a file, a field, a specifier, a generic declaration, a function declaration or a go.mod expression.
Examples:
// function documentation
func double(x int) int { return 2 * x }
// generic declaration documentation
const (
// specifier documentation
size int64 = 1024
eof = -1 // not specifier documentation
)
Import path
import semmle.go.CommentsDirect supertypes
Indirect supertypes
Known direct subtypes
Predicates
| getDocumentation | Gets the documentation comment group attached to this element, if any. |
Inherited predicates
| getAChild | Gets a child node of this node. | from AstNode |
| getAPrimaryQlClass | Gets the name of a primary CodeQL class to which this node belongs. | from AstNode |
| getChild | Gets the | from AstNode |
| getEnclosingFunction | Gets the innermost function definition to which this AST node belongs, if any. | from AstNode |
| getFile | Gets the file this program element comes from. | from Locatable |
| getLocation | Gets this element’s location. | from Locatable |
| getNumChild | Gets the number of child nodes of this node. | from AstNode |
| getNumLines | Gets the number of lines covered by this element. | from Locatable |
| getParent | Gets the parent node of this AST node, if any. | from AstNode |
| getPrimaryQlClasses | Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs. | from AstNode |
| getUniquelyNumberedChild | Get an AstNode child, ordered by child kind and then by index. | from AstNode |
| hasLocationInfo | Holds if this element is at the specified location. The location spans column | from Locatable |
| toString | Gets a textual representation of this element. | from AstNode |