Class DocComment

A comment group that is attached to a program element as documentation.

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.Comments

Direct supertypes

CommentGroup

Indirect supertypes

Fields

node

Predicates

getAPrimaryQlClass	Gets the name of a primary CodeQL class to which this node belongs.
getDocumentedElement	Gets the program element documented by this comment group.

Inherited predicates

getAChild	Gets a child node of this node.	from AstNode
getAComment	Gets a comment in this group.	from CommentGroup
getChild	Gets the `i`th child node of this node.	from AstNode
getComment	Gets the `i`th comment in this group (0-based indexing).	from CommentGroup
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
getNumComment	Gets the number of comments in this group.	from CommentGroup
getNumLines	Gets the number of lines covered by this element.	from Locatable
getParent	Gets the file to which this comment group belongs.	from CommentGroup
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 `startcolumn` of line `startline` to column `endcolumn` of line `endline` in file `filepath`. For more information, see Locations.	from Locatable
toString	Gets a textual representation of this element.	from CommentGroup

Charpred

DocComment