struct DeclInfo

Declaration

struct DeclInfo { /* full declaration omitted */ };

Description

Information about the declaration, useful to clients of FullComment.

Declared at: clang/include/clang/AST/Comment.h:963

Member Variables

public const clang::Decl* CommentDecl
Declaration the comment is actually attached to (in the source). Should not be NULL.
public const clang::Decl* CurrentDecl
The information in the DeclInfo corresponds to CurrentDecl.
public ArrayRef<const clang::ParmVarDecl*> ParamVars
Parameters that can be referenced by \ param if \c CommentDecl is something that we consider a "function".
public clang::QualType ReturnType
Function return type if \c CommentDecl is something that we consider a "function".
public const clang::TemplateParameterList* TemplateParameters
Template parameters that can be referenced by \ tparam if \c CommentDecl is a template (\c IsTemplateDecl or \c IsTemplatePartialSpecialization is true).
public unsigned int IsFilled
If false, only \c CommentDecl is valid.
public unsigned int Kind
Simplified kind of \c CommentDecl, see \c DeclKind enum.
public unsigned int TemplateKind
Is \c CommentDecl a template declaration.
public unsigned int IsObjCMethod
Is \c CommentDecl an ObjCMethodDecl.
public unsigned int IsInstanceMethod
Is \c CommentDecl a non-static member function of C++ class or instance method of ObjC class. Can be true only if \c IsFunctionDecl is true.
public unsigned int IsClassMethod
Is \c CommentDecl a static member function of C++ class or class method of ObjC class. Can be true only if \c IsFunctionDecl is true.
public unsigned int IsVariadic
Is \c CommentDecl something we consider a "function" that's variadic.

Method Overview

Methods

void fill()

Declared at: clang/include/clang/AST/Comment.h:1063

clang::comments::DeclInfo::DeclKind getKind()
    const

Declared at: clang/include/clang/AST/Comment.h:1065

clang::comments::DeclInfo::TemplateDeclKind
getTemplateKind() const

Declared at: clang/include/clang/AST/Comment.h:1069

bool involvesFunctionType() const

Declared at: clang/include/clang/AST/Comment.h:1073