Information about the declaration, useful to clients of FullComment. More...
#include "clang/AST/Comment.h"
Information about the declaration, useful to clients of FullComment.
Definition at line 962 of file Comment.h.
◆ DeclKindA simplified description of CommentDecl
kind that should be good enough for documentation rendering purposes.
Everything else not explicitly mentioned below.
FunctionKindSomething that we consider a "function":
Something that we consider a "class":
Something that we consider a "variable":
A C++ namespace.
TypedefKindA C++ typedef-name (a 'typedef' decl specifier or alias-declaration), see TypedefNameDecl
.
An enumeration or scoped enumeration.
Definition at line 992 of file Comment.h.
◆ TemplateDeclKindWhat kind of template specialization CommentDecl
is.
Definition at line 1030 of file Comment.h.
◆ fill() void clang::comments::DeclInfo::fill ( )Definition at line 203 of file Comment.cpp.
References ClassKind, CommentDecl, CurrentDecl, EnumKind, FunctionKind, clang::comments::getFunctionTypeLoc(), clang::Decl::getKind(), clang::DeclaratorDecl::getNumTemplateParameterLists(), clang::FunctionTypeLoc::getParams(), clang::FunctionTypeLoc::getReturnLoc(), clang::FunctionDecl::getReturnType(), clang::ObjCMethodDecl::getReturnType(), clang::FunctionTemplateDecl::getTemplatedDecl(), clang::TypeAliasTemplateDecl::getTemplatedDecl(), clang::VarTemplateDecl::getTemplatedDecl(), clang::DeclaratorDecl::getTemplateParameterList(), clang::TemplateDecl::getTemplateParameters(), clang::ClassTemplatePartialSpecializationDecl::getTemplateParameters(), clang::TypeLoc::getType(), clang::TypeSourceInfo::getTypeLoc(), clang::ConcreteTypeLoc< Base, Derived, TypeClass, LocalData >::getTypePtr(), clang::TypeLoc::getUnqualifiedLoc(), involvesFunctionType(), IsClassMethod, IsFilled, clang::CXXMethodDecl::isInstance(), IsInstanceMethod, clang::ObjCMethodDecl::isInstanceMethod(), IsObjCMethod, IsVariadic, clang::FunctionDecl::isVariadic(), clang::ObjCMethodDecl::isVariadic(), Kind, NamespaceKind, NotTemplate, OtherKind, clang::FunctionDecl::parameters(), clang::ObjCMethodDecl::parameters(), ParamVars, ReturnType, Template, TemplateKind, TemplateParameters, TemplatePartialSpecialization, TemplateSpecialization, TypedefKind, and VariableKind.
Referenced by clang::comments::FullComment::getDeclInfo().
◆ getKind() DeclKind clang::comments::DeclInfo::getKind ( ) const inline ◆ getTemplateKind() ◆ involvesFunctionType() bool clang::comments::DeclInfo::involvesFunctionType ( ) const inline ◆ CommentDecl const Decl* clang::comments::DeclInfo::CommentDecl ◆ CurrentDecl const Decl* clang::comments::DeclInfo::CurrentDeclCurrentDecl is the declaration with which the FullComment is associated.
It can be different from CommentDecl
. It happens when we decide that the comment originally attached to CommentDecl
is fine for CurrentDecl
too (for example, for a redeclaration or an overrider of CommentDecl
).
The information in the DeclInfo corresponds to CurrentDecl.
Definition at line 975 of file Comment.h.
Referenced by fill().
◆ IsClassMethod unsigned clang::comments::DeclInfo::IsClassMethodIs CommentDecl
a static member function of C++ class or class method of ObjC class.
Can be true only if IsFunctionDecl
is true.
Definition at line 1063 of file Comment.h.
Referenced by fill().
◆ IsFilled unsigned clang::comments::DeclInfo::IsFilled ◆ IsInstanceMethod unsigned clang::comments::DeclInfo::IsInstanceMethodIs CommentDecl
a non-static member function of C++ class or instance method of ObjC class.
Can be true only if IsFunctionDecl
is true.
Definition at line 1057 of file Comment.h.
Referenced by fill().
◆ IsObjCMethod unsigned clang::comments::DeclInfo::IsObjCMethod ◆ IsVariadic unsigned clang::comments::DeclInfo::IsVariadicIs CommentDecl
something we consider a "function" that's variadic.
Definition at line 1067 of file Comment.h.
Referenced by fill().
◆ Kind unsigned clang::comments::DeclInfo::Kind ◆ ParamVars ◆ ReturnType QualType clang::comments::DeclInfo::ReturnType ◆ TemplateKind unsigned clang::comments::DeclInfo::TemplateKind ◆ TemplateParametersThe documentation for this struct was generated from the following files:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4