OOInteraction::DoxygenCommentsOnlyVisitor Class Reference

The DoxygenCommentsOnlyVisitor class transforms the documentation of a node to Doxygen compatible text. More...

Inheritance diagram for OOInteraction::DoxygenCommentsOnlyVisitor:

Static Public Member Functions
static void	init ()
Static Public Member Functions inherited from Model::Visitor< DoxygenCommentsOnlyVisitor, QString >
static void	addType (std::function< QString(DoxygenCommentsOnlyVisitor *, NodeType *)> f)

Static Private Member Functions
static QString	replaceMarkdown (QString str)

Static Private Attributes
static const QString	DOXY_END = QString{" */\n"}
static const QString	DOXY_START = QString{"/**\n"}
static const bool	USE_SVG = true

Additional Inherited Members
Public Types inherited from Model::Visitor< DoxygenCommentsOnlyVisitor, QString >
using	BaseVisitorType = DoxygenCommentsOnlyVisitor
using	VisitFunctionInstance = std::function< QString(DoxygenCommentsOnlyVisitor *, Node *)>
using	VisitorResultType = QString
Public Member Functions inherited from Model::Visitor< DoxygenCommentsOnlyVisitor, QString >
virtual	~Visitor ()
QString	visit (Node *n)
virtual QString	visitChildren (Node *n)
Protected Member Functions inherited from Model::Visitor< DoxygenCommentsOnlyVisitor, QString >
virtual VisitFunctionInstance	findFunctionForId (int id)

Detailed Description

The DoxygenCommentsOnlyVisitor class transforms the documentation of a node to Doxygen compatible text.

It also saves an image of appropriate comment elements to the Doxygen output directory.

Member Function Documentation

init()

void OOInteraction::DoxygenCommentsOnlyVisitor::init ( )

static

replaceMarkdown()

QString OOInteraction::DoxygenCommentsOnlyVisitor::replaceMarkdown ( QString  str )

staticprivate

Member Data Documentation

DOXY_END

const QString OOInteraction::DoxygenCommentsOnlyVisitor::DOXY_END = QString{" */\n"}

staticprivate

DOXY_START

const QString OOInteraction::DoxygenCommentsOnlyVisitor::DOXY_START = QString{"/**\n"}

staticprivate

USE_SVG

const bool OOInteraction::DoxygenCommentsOnlyVisitor::USE_SVG = true

staticprivate