clang-tools 22.0.0git
clang::clangd::SymbolDocCommentVisitor Class Reference

#include <SymbolDocumentation.h>

Inheritance diagram for clang::clangd::SymbolDocCommentVisitor:
[legend]

Public Member Functions

 SymbolDocCommentVisitor (comments::FullComment *FC, const CommentOptions &CommentOpts)
 SymbolDocCommentVisitor (llvm::StringRef Documentation, const CommentOptions &CommentOpts)
bool isParameterDocumented (StringRef ParamName) const
bool isTemplateTypeParmDocumented (StringRef ParamName) const
bool hasBriefCommand () const
bool hasReturnCommand () const
bool hasRetvalCommands () const
bool hasNoteCommands () const
bool hasWarningCommands () const
void docToMarkup (markup::Document &Out) const
 Converts all unhandled comment commands to a markup document.
void briefToMarkup (markup::Paragraph &Out) const
 Converts the "brief" command(s) to a markup document.
void returnToMarkup (markup::Paragraph &Out) const
 Converts the "return" command(s) to a markup document.
void notesToMarkup (markup::Document &Out) const
 Converts the "note" command(s) to a markup document.
void warningsToMarkup (markup::Document &Out) const
 Converts the "warning" command(s) to a markup document.
void visitBlockCommandComment (const comments::BlockCommandComment *B)
void templateTypeParmDocToMarkup (StringRef TemplateParamName, markup::Paragraph &Out) const
void templateTypeParmDocToString (StringRef TemplateParamName, llvm::raw_string_ostream &Out) const
void parameterDocToMarkup (StringRef ParamName, markup::Paragraph &Out) const
void parameterDocToString (StringRef ParamName, llvm::raw_string_ostream &Out) const
void visitParagraphComment (const comments::ParagraphComment *P)
void visitParamCommandComment (const comments::ParamCommandComment *P)
void visitTParamCommandComment (const comments::TParamCommandComment *TP)

Detailed Description

Definition at line 30 of file SymbolDocumentation.h.

Constructor & Destructor Documentation

◆ SymbolDocCommentVisitor() [1/2]

clang::clangd::SymbolDocCommentVisitor::SymbolDocCommentVisitor ( comments::FullComment * FC,
const CommentOptions & CommentOpts )
inline

Definition at line 33 of file SymbolDocumentation.h.

◆ SymbolDocCommentVisitor() [2/2]

clang::clangd::SymbolDocCommentVisitor::SymbolDocCommentVisitor ( llvm::StringRef Documentation,
const CommentOptions & CommentOpts )
inline

Definition at line 44 of file SymbolDocumentation.h.

Member Function Documentation

◆ briefToMarkup()

void clang::clangd::SymbolDocCommentVisitor::briefToMarkup ( markup::Paragraph & Out) const

Converts the "brief" command(s) to a markup document.

Definition at line 315 of file SymbolDocumentation.cpp.

◆ docToMarkup()

void clang::clangd::SymbolDocCommentVisitor::docToMarkup ( markup::Document & Out) const

Converts all unhandled comment commands to a markup document.

Definition at line 355 of file SymbolDocumentation.cpp.

Referenced by clang::clangd::TEST().

◆ hasBriefCommand()

bool clang::clangd::SymbolDocCommentVisitor::hasBriefCommand ( ) const
inline

Definition at line 113 of file SymbolDocumentation.h.

◆ hasNoteCommands()

bool clang::clangd::SymbolDocCommentVisitor::hasNoteCommands ( ) const
inline

Definition at line 119 of file SymbolDocumentation.h.

◆ hasReturnCommand()

bool clang::clangd::SymbolDocCommentVisitor::hasReturnCommand ( ) const
inline

Definition at line 115 of file SymbolDocumentation.h.

◆ hasRetvalCommands()

bool clang::clangd::SymbolDocCommentVisitor::hasRetvalCommands ( ) const
inline

Definition at line 117 of file SymbolDocumentation.h.

◆ hasWarningCommands()

bool clang::clangd::SymbolDocCommentVisitor::hasWarningCommands ( ) const
inline

Definition at line 121 of file SymbolDocumentation.h.

◆ isParameterDocumented()

bool clang::clangd::SymbolDocCommentVisitor::isParameterDocumented ( StringRef ParamName) const
inline

Definition at line 105 of file SymbolDocumentation.h.

◆ isTemplateTypeParmDocumented()

bool clang::clangd::SymbolDocCommentVisitor::isTemplateTypeParmDocumented ( StringRef ParamName) const
inline

Definition at line 109 of file SymbolDocumentation.h.

◆ notesToMarkup()

void clang::clangd::SymbolDocCommentVisitor::notesToMarkup ( markup::Document & Out) const

Converts the "note" command(s) to a markup document.

Definition at line 327 of file SymbolDocumentation.cpp.

◆ parameterDocToMarkup()

void clang::clangd::SymbolDocCommentVisitor::parameterDocToMarkup ( StringRef ParamName,
markup::Paragraph & Out ) const

Definition at line 335 of file SymbolDocumentation.cpp.

◆ parameterDocToString()

void clang::clangd::SymbolDocCommentVisitor::parameterDocToString ( StringRef ParamName,
llvm::raw_string_ostream & Out ) const

Definition at line 345 of file SymbolDocumentation.cpp.

Referenced by clang::clangd::getDeclComment().

◆ returnToMarkup()

void clang::clangd::SymbolDocCommentVisitor::returnToMarkup ( markup::Paragraph & Out) const

Converts the "return" command(s) to a markup document.

Definition at line 321 of file SymbolDocumentation.cpp.

◆ templateTypeParmDocToMarkup()

void clang::clangd::SymbolDocCommentVisitor::templateTypeParmDocToMarkup ( StringRef TemplateParamName,
markup::Paragraph & Out ) const

Definition at line 365 of file SymbolDocumentation.cpp.

◆ templateTypeParmDocToString()

void clang::clangd::SymbolDocCommentVisitor::templateTypeParmDocToString ( StringRef TemplateParamName,
llvm::raw_string_ostream & Out ) const

Definition at line 375 of file SymbolDocumentation.cpp.

Referenced by clang::clangd::getDeclComment().

◆ visitBlockCommandComment()

void clang::clangd::SymbolDocCommentVisitor::visitBlockCommandComment ( const comments::BlockCommandComment * B)

Definition at line 267 of file SymbolDocumentation.cpp.

◆ visitParagraphComment()

void clang::clangd::SymbolDocCommentVisitor::visitParagraphComment ( const comments::ParagraphComment * P)
inline

Definition at line 147 of file SymbolDocumentation.h.

◆ visitParamCommandComment()

void clang::clangd::SymbolDocCommentVisitor::visitParamCommandComment ( const comments::ParamCommandComment * P)
inline

Definition at line 152 of file SymbolDocumentation.h.

◆ visitTParamCommandComment()

void clang::clangd::SymbolDocCommentVisitor::visitTParamCommandComment ( const comments::TParamCommandComment * TP)
inline

Definition at line 156 of file SymbolDocumentation.h.

◆ warningsToMarkup()

void clang::clangd::SymbolDocCommentVisitor::warningsToMarkup ( markup::Document & Out) const

Converts the "warning" command(s) to a markup document.

Definition at line 331 of file SymbolDocumentation.cpp.


The documentation for this class was generated from the following files: