CodeQL library for Go
codeql/go-all 1.1.0 (changelog, source)
Search

Class CommentGroup

A comment group, that is, a sequence of comments without any intervening tokens or empty lines.

Examples:

 // a line comment
 // another line comment

 // a line comment
 /* a block
   comment */

 /* a block
 comment */
 /* another block comment */
 

Import path

import semmle.go.Comments

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAComment

Gets a comment in this group.

getAPrimaryQlClass

Gets the name of a primary CodeQL class to which this node belongs.

getComment

Gets the ith comment in this group (0-based indexing).

getNumComment

Gets the number of comments in this group.

getParent

Gets the file to which this comment group belongs.

toString

Gets a textual representation of this element.

Inherited predicates

getAChild

Gets a child node of this node.

from AstNode
getChild

Gets the ith child node of this node.

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