clanguml::common::visitor::comment::plain_visitor Class Reference

Plain comment visitor which extracts raw and formatted comment. More...

Detailed Description

Plain comment visitor which extracts raw and formatted comment.

Definition at line 31 of file plain_visitor.h.

#include <plain_visitor.h>

Public Member Functions
	plain_visitor (clang::SourceManager &source_manager)
void	visit (const clang::NamedDecl &decl, common::model::decorated_element &e) override
Public Member Functions inherited from clanguml::common::visitor::comment::comment_visitor
	comment_visitor (clang::SourceManager &source_manager)
virtual	~comment_visitor ()=default
virtual void	visit (const clang::NamedDecl &decl, common::model::decorated_element &e)=0
clang::SourceManager &	source_manager ()

Constructor & Destructor Documentation

plain_visitor()

clanguml::common::visitor::comment::plain_visitor::plain_visitor

(

clang::SourceManager &

source_manager

)

Definition at line 23 of file plain_visitor.cc.

    : comment_visitor{source_manager}
{
}

Member Function Documentation

visit()

void clanguml::common::visitor::comment::plain_visitor::visit ( const clang::NamedDecl &  decl, common::model::decorated_element &  e  )

overridevirtual

Extracts 'raw' and 'formatted' comment values from the Clang's parser.

Parameters

decl	Clang's named declaration
e	Diagram element

Implements clanguml::common::visitor::comment::comment_visitor.

Definition at line 28 of file plain_visitor.cc.

{
    const auto *comment =
        decl.getASTContext().getRawCommentForDeclNoCache(&decl);
 
    if (comment == nullptr) {
        return;
    }
 
    auto raw_comment = comment->getRawText(source_manager());
 
    auto formatted_comment = comment->getFormattedText(
        source_manager(), decl.getASTContext().getDiagnostics());
 
    common::model::comment_t cmt = inja::json::object();
    cmt["raw"] = raw_comment;
    cmt["formatted"] = formatted_comment;
 
    e.set_comment(cmt);
}

---

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

• src/common/visitor/comment/plain_visitor.h
• src/common/visitor/comment/plain_visitor.cc