Doxygen
Loading...
Searching...
No Matches
DocDotFile Class Reference

Node representing a dot file. More...

#include <src/docnode.h>

Inheritance diagram for DocDotFile:
Collaboration diagram for DocDotFile:

Public Member Functions

 DocDotFile (DocParser *parser, DocNodeVariant *parent, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
bool parse ()
Public Member Functions inherited from DocDiagramFileBase
 DocDiagramFileBase (DocParser *parser, DocNodeVariant *parent, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
QCString name () const
QCString file () const
QCString relPath () const
bool hasCaption () const
QCString width () const
QCString height () const
QCString context () const
QCString srcFile () const
int srcLine () const
Public Member Functions inherited from DocCompoundNode
 DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeListchildren ()
const DocNodeListchildren () const
Public Member Functions inherited from DocNode
 DocNode (DocParser *parser, DocNodeVariant *parent)
 ~DocNode ()=default
DocNodeVariantparent ()
const DocNodeVariantparent () const
DocNodeVariantthisVariant ()
const DocNodeVariantthisVariant () const
void setThisVariant (DocNodeVariant *thisVariant)
DocParserparser ()
const DocParserparser () const
void setParent (DocNodeVariant *parent)
bool isPreformatted () const

Additional Inherited Members

Protected Types inherited from DocNode
enum  RefType { Unknown , Anchor , Section , Table }
Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)
Protected Attributes inherited from DocDiagramFileBase
std::unique_ptr< Privatep

Detailed Description

Node representing a dot file.

Definition at line 712 of file docnode.h.

Constructor & Destructor Documentation

◆ DocDotFile()

DocDotFile::DocDotFile ( DocParser * parser,
DocNodeVariant * parent,
const QCString & name,
const QCString & context,
const QCString & srcFile,
int srcLine )

Definition at line 1103 of file docnode.cpp.

1104 :
1106{
1107 p->relPath = parser->context.relPath;
1108}
QCString srcFile() const
Definition docnode.h:691
std::unique_ptr< Private > p
Definition docnode.h:708
int srcLine() const
Definition docnode.h:692
DocDiagramFileBase(DocParser *parser, DocNodeVariant *parent, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
Definition docnode.h:681
QCString context() const
Definition docnode.h:690
QCString name() const
Definition docnode.h:684
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90

References DocDiagramFileBase::context(), DocDiagramFileBase::DocDiagramFileBase(), DocDiagramFileBase::name(), DocDiagramFileBase::p, parent(), DocNode::parser(), DocDiagramFileBase::srcFile(), and DocDiagramFileBase::srcLine().

Member Function Documentation

◆ parse()

bool DocDotFile::parse ( )

Definition at line 1110 of file docnode.cpp.

1111{
1112 bool ok = false;
1114
1115 bool ambig = false;
1116 FileDef *fd = findFileDef(Doxygen::dotFileNameLinkedMap,p->name,ambig);
1117 if (fd==nullptr && !p->name.endsWith(".dot")) // try with .dot extension as well
1118 {
1119 fd = findFileDef(Doxygen::dotFileNameLinkedMap,p->name+".dot",ambig);
1120 }
1121 if (fd)
1122 {
1123 p->file = fd->absFilePath();
1124 ok = true;
1125 if (ambig)
1126 {
1127 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"included dot file name '{}' is ambiguous.\n"
1128 "Possible candidates:\n{}",p->name,
1130 );
1131 }
1132 }
1133 else
1134 {
1135 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"included dot file '{}' is not found "
1136 "in any of the paths specified via DOTFILE_DIRS!",p->name);
1137 }
1138 return ok;
1139}
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
void defaultHandleTitleAndSize(const CommandType cmd, DocNodeVariant *parent, DocNodeList &children, QCString &width, QCString &height)
static FileNameLinkedMap * dotFileNameLinkedMap
Definition doxygen.h:107
virtual QCString absFilePath() const =0
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
QCString showFileDefMatches(const FileNameLinkedMap *fnMap, const QCString &n)
Definition util.cpp:3543
FileDef * findFileDef(const FileNameLinkedMap *fnMap, const QCString &n, bool &ambig)
Definition util.cpp:3417

References FileDef::absFilePath(), DocCompoundNode::children(), CMD_DOTFILE, DocDiagramFileBase::context(), DocParser::defaultHandleTitleAndSize(), Doxygen::dotFileNameLinkedMap, findFileDef(), DocDiagramFileBase::p, DocNode::parser(), showFileDefMatches(), DocNode::thisVariant(), and warn_doc_error.


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