clang 20.0.0git
Classes | Namespaces | Macros | Enumerations
Comment.h File Reference
#include "clang/AST/CommentCommandTraits.h"
#include "clang/AST/DeclObjC.h"
#include "clang/AST/Type.h"
#include "clang/Basic/SourceLocation.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/StringRef.h"
#include "clang/AST/CommentNodes.inc"

Go to the source code of this file.

Classes

class  clang::comments::Comment
 Any part of the comment. More...
 
class  clang::comments::Comment::CommentBitfields
 
class  clang::comments::Comment::InlineContentCommentBitfields
 
class  clang::comments::Comment::TextCommentBitfields
 
class  clang::comments::Comment::InlineCommandCommentBitfields
 
class  clang::comments::Comment::HTMLTagCommentBitfields
 
class  clang::comments::Comment::HTMLStartTagCommentBitfields
 
class  clang::comments::Comment::ParagraphCommentBitfields
 
class  clang::comments::Comment::BlockCommandCommentBitfields
 
class  clang::comments::Comment::ParamCommandCommentBitfields
 
struct  clang::comments::Comment::Argument
 
class  clang::comments::InlineContentComment
 Inline content (contained within a block). More...
 
class  clang::comments::TextComment
 Plain text. More...
 
class  clang::comments::InlineCommandComment
 A command with word-like arguments that is considered inline content. More...
 
class  clang::comments::HTMLTagComment
 Abstract class for opening and closing HTML tags. More...
 
class  clang::comments::HTMLStartTagComment
 An opening HTML tag with attributes. More...
 
class  clang::comments::HTMLStartTagComment::Attribute
 
class  clang::comments::HTMLEndTagComment
 A closing HTML tag. More...
 
class  clang::comments::BlockContentComment
 Block content (contains inline content). More...
 
class  clang::comments::ParagraphComment
 A single paragraph that contains inline content. More...
 
class  clang::comments::BlockCommandComment
 A command that has zero or more word-like arguments (number of word-like arguments depends on command name) and a paragraph as an argument (e. More...
 
class  clang::comments::ParamCommandComment
 Doxygen \param command. More...
 
class  clang::comments::TParamCommandComment
 Doxygen \tparam command, describes a template parameter. More...
 
class  clang::comments::VerbatimBlockLineComment
 A line of text contained in a verbatim block. More...
 
class  clang::comments::VerbatimBlockComment
 A verbatim block command (e. More...
 
class  clang::comments::VerbatimLineComment
 A verbatim line command. More...
 
struct  clang::comments::DeclInfo
 Information about the declaration, useful to clients of FullComment. More...
 
class  clang::comments::FullComment
 A full comment attached to a declaration, contains block content. More...
 

Namespaces

namespace  clang
 The JSON file list parser is used to communicate input to InstallAPI.
 
namespace  clang::comments
 

Macros

#define COMMENT(CLASS, PARENT)   CLASS,
 
#define COMMENT_RANGE(BASE, FIRST, LAST)    First##BASE##Constant = FIRST, Last##BASE##Constant = LAST,
 
#define LAST_COMMENT_RANGE(BASE, FIRST, LAST)    First##BASE##Constant = FIRST, Last##BASE##Constant = LAST
 
#define ABSTRACT_COMMENT(COMMENT)
 

Enumerations

enum  clang::comments::CommandMarkerKind { clang::comments::CMK_Backslash = 0 , clang::comments::CMK_At = 1 }
 Describes the syntax that was used in a documentation command. More...
 
enum class  clang::comments::CommentKind {
  clang::comments::None = 0 , clang::comments::COMMENT , clang::comments::COMMENT_RANGE , clang::comments::LAST_COMMENT_RANGE ,
  clang::comments::ABSTRACT_COMMENT
}
 
enum class  clang::comments::InlineCommandRenderKind {
  clang::comments::Normal , clang::comments::Bold , clang::comments::Monospaced , clang::comments::Emphasized ,
  clang::comments::Anchor
}
 The most appropriate rendering mode for this command, chosen on command semantics in Doxygen. More...
 
enum class  clang::comments::ParamCommandPassDirection { clang::comments::In , clang::comments::Out , clang::comments::InOut }
 

Macro Definition Documentation

◆ ABSTRACT_COMMENT

#define ABSTRACT_COMMENT (   COMMENT)

Definition at line 59 of file Comment.h.

◆ COMMENT

#define COMMENT (   CLASS,
  PARENT 
)    CLASS,

Definition at line 54 of file Comment.h.

◆ COMMENT_RANGE

#define COMMENT_RANGE (   BASE,
  FIRST,
  LAST 
)     First##BASE##Constant = FIRST, Last##BASE##Constant = LAST,

Definition at line 55 of file Comment.h.

◆ LAST_COMMENT_RANGE

#define LAST_COMMENT_RANGE (   BASE,
  FIRST,
  LAST 
)     First##BASE##Constant = FIRST, Last##BASE##Constant = LAST

Definition at line 57 of file Comment.h.