CodeQL library for C#
codeql/csharp-all 3.0.1-dev (changelog, source)
Search

Class CommentBlock

A collection of adjacent comment lines, for example

/// <summary>
/// Represents a named tuple.
/// </summary>

Import path

import csharp

Direct supertypes

Predicates

getAChild

Gets a comment line in this comment block.

getALine

Gets a line of text in this comment block.

getANonEmptyLine

Gets a CommentLine containing text.

getAProbableCodeLine

Gets a CommentLine that might contain code.

getAfter

Gets the Element after this comment, if any.

getAnElement

Gets an Element possibly associated with this comment. This is a superset of getElement().

getBefore

Gets the Element before this comment block, if any.

getChild

Gets the cth child of this comment block (numbered from 0).

getElement

Gets the Element that this comment block most probably refers to.

getLocation

Gets the location of this comment block

getNumLines

Gets the number of lines in this comment block.

getParent

Gets the Element that contains this comment block, if any.

isOrphan

Holds if the comment has no associated Element.

isXmlCommentBlock

Holds if this block consists entirely of XML comments.

toString

Gets a textual representation of this comment block.