CodeQL library for C/C++
codeql/cpp-all 0.3.3 (changelog, source)
Search

Class Comment

A C/C++ comment. For example the comment in the following code:

// C++ style single-line comment

or a C style comment (which starts with /*).

Import path

import cpp

Direct supertypes

Indirect supertypes

Known direct subtypes

    Predicates

    getCommentedElement

    Gets the AST element this comment is associated with. For example, the comment in the following code is associated with the declaration of j. int i; int j; // Comment on j

    getContents

    Gets the text of this comment, including the opening // or /*, and the closing *``/ if present.

    getLocation

    Gets the primary location of this element.

    toString

    Gets a textual representation of this element.

    Inherited predicates

    findRootCause

    Gets the source of this element: either itself or a macro that expanded to this element.

    from Element
    fromSource

    Holds if this element may be from source. This predicate holds for all elements, except for those in the dummy file, whose name is the empty string. The dummy file contains declarations that are built directly into the compiler.

    from Element
    getAPrimaryQlClass

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

    from ElementBase
    getEnclosingElement

    Gets the closest Element enclosing this one.

    from Element
    getFile

    Gets the primary file where this element occurs.

    from Element
    getParentScope

    Gets the parent scope of this Element, if any. A scope is a Type (Class / Enum), a Namespace, a BlockStmt, a Function, or certain kinds of Statement.

    from Element
    getPrimaryQlClasses

    Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

    from ElementBase
    isAffectedByMacro

    Holds if this element is affected in any way by a macro. All elements that are totally or partially generated by a macro are included, so this is a super-set of isInMacroExpansion.

    from Element
    isFromTemplateInstantiation

    Holds if this Element is a part of a template instantiation (but not the template itself).

    from Element
    isFromUninstantiatedTemplate

    Holds if this Element is part of a template template (not if it is part of an instantiation of template). This means it is represented in the database purely as syntax and without guarantees on the presence or correctness of type-based operations such as implicit conversions.

    from Element
    isInMacroExpansion

    Holds if this element comes from a macro expansion. Only elements that are entirely generated by a macro are included - for elements that partially come from a macro, see isAffectedByMacro.

    from Element