The DocPlantUmlFile Class Reference

Node representing a uml file. More...

Declaration

class DocPlantUmlFile { ... }

Included Headers

#include <src/docnode.h>

Base class

class	DocDiagramFileBase

Public Constructors Index

	DocPlantUmlFile (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 uml file.

Definition at line 739 of file docnode.h.

Public Constructors

DocPlantUmlFile()

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

Declaration at line 742 of file docnode.h, definition at line 1207 of file docnode.cpp.

1207DocPlantUmlFile::DocPlantUmlFile(DocParser *parser,DocNodeVariant *parent,const QCString &name,const QCString &context,

1208 const QCString &srcFile,int srcLine) :

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

1210{

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

1212}

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

Public Member Functions

parse()

bool DocPlantUmlFile::parse ()

Declaration at line 744 of file docnode.h, definition at line 1214 of file docnode.cpp.

1214bool DocPlantUmlFile::parse()

1215{

1216 bool ok = false;

1217 parser()->defaultHandleTitleAndSize(CommandType::CMD_PLANTUMLFILE,thisVariant(),children(),p->width,p->height);

1218

1219 bool ambig = false;

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

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

1222 {

1223 fd = findFileDef(Doxygen::plantUmlFileNameLinkedMap,p->name+".puml",ambig);

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

1225 {

1226 fd = findFileDef(Doxygen::plantUmlFileNameLinkedMap,p->name+".pu",ambig);

1227 }

1228 }

1229 if (fd)

1230 {

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

1232 ok = true;

1233 if (ambig)

1234 {

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

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

1237 showFileDefMatches(Doxygen::plantUmlFileNameLinkedMap,p->name)

1238 );

1239 }

1240 }

1241 else

1242 {

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

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

1245 }

1246 return ok;

1247}

References FileDef::absFilePath, DocCompoundNode::children, CMD_PLANTUMLFILE, DocDiagramFileBase::context, DocParser::defaultHandleTitleAndSize, findFileDef, DocDiagramFileBase::p, DocNode::parser, Doxygen::plantUmlFileNameLinkedMap, 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.