The DocDotFile Class Reference

Node representing a dot file. More...

Declaration

class DocDotFile { ... }

Included Headers

#include <src/docnode.h>

Base class

class	DocDiagramFileBase

Public Constructors Index

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

Public Member Functions Index

bool	parse ()

Description

Node representing a dot file.

Definition at line 712 of file docnode.h.

Public Constructors

DocDotFile()

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

Declaration at line 715 of file docnode.h, definition at line 1090 of file docnode.cpp.

1090DocDotFile::DocDotFile(DocParser *parser,DocNodeVariant *parent,const QCString &name,const QCString &context,

1091 const QCString &srcFile,int srcLine) :

1092 DocDiagramFileBase(parser,parent,name,context,srcFile,srcLine)

1093{

1094 p->relPath = parser->context.relPath;

1095}

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

Public Member Functions

parse()

bool DocDotFile::parse ()

Declaration at line 717 of file docnode.h, definition at line 1097 of file docnode.cpp.

1097bool DocDotFile::parse()

1098{

1099 bool ok = false;

1100 parser()->defaultHandleTitleAndSize(CommandType::CMD_DOTFILE,thisVariant(),children(),p->width,p->height);

1101

1102 bool ambig = false;

1103 FileDef *fd = findFileDef(Doxygen::dotFileNameLinkedMap,p->name,ambig);

1104 if (fd==nullptr && !p->name.endsWith(".dot")) // try with .dot extension as well

1105 {

1106 fd = findFileDef(Doxygen::dotFileNameLinkedMap,p->name+".dot",ambig);

1107 }

1108 if (fd)

1109 {

1110 p->file = fd->absFilePath();

1111 ok = true;

1112 if (ambig)

1113 {

1114 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"included dot file name '{}' is ambiguous.\n"

1115 "Possible candidates:\n{}",p->name,

1116 showFileDefMatches(Doxygen::dotFileNameLinkedMap,p->name)

1117 );

1118 }

1119 }

1120 else

1121 {

1122 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"included dot file '{}' is not found "

1123 "in any of the paths specified via DOTFILE_DIRS!",p->name);

1124 }

1125 return ok;

1126}

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:

• docnode.cpp
• docnode.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.