CodeQL library for C#
Search

Class XmlComment

A line of XML documentation comment, for example each of the lines in

/// <summary>
///   This method ...
/// </summary>

Import path

import csharp

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAttribute

Gets the XML attribute value for an XML element, for a given XML attribute name key and element offset offset.

getCloseTag

Gets the name of the closing tag at offset offset.

getEmptyTag

Gets the name of the empty tag at offset offset.

getOpenTag

Gets the name of the opening tag at offset offset.

hasBody

Holds if the XML element at the given offset is not empty.

toString

Gets a textual representation of this comment line.

Inherited predicates

getLocation

Gets the location of this comment line.

from CommentLine
getParent

Gets the containing comment block.

from CommentLine
getRawText

Gets the raw text of the comment, including the comment markers.

from CommentLine
getText

Gets the text in the comment, trimmed to remove comment markers and leading and trailing whitespace.

from CommentLine