DocPlantUmlFile Class Reference

Node representing a uml file. More...

#include <src/docnode.h>

Inheritance diagram for DocPlantUmlFile:

Collaboration diagram for DocPlantUmlFile:

Public Member Functions
	DocPlantUmlFile (DocParser *parser, DocNodeVariant *parent, const DString &name, const DString &context, const DString &srcFile, int srcLine)
bool	parse ()
Public Member Functions inherited from DocDiagramFileBase
	DocDiagramFileBase (DocParser *parser, DocNodeVariant *parent, const DString &name, const DString &context, const DString &srcFile, int srcLine)
DString	name () const
DString	file () const
DString	relPath () const
bool	hasCaption () const
DString	width () const
DString	height () const
DString	context () const
DString	srcFile () const
int	srcLine () const
Public Member Functions inherited from DocCompoundNode
	DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeList &	children ()
const DocNodeList &	children () const
Public Member Functions inherited from DocNode
	DocNode (DocParser *parser, DocNodeVariant *parent)
	~DocNode ()=default
DocNodeVariant *	parent ()
const DocNodeVariant *	parent () const
DocNodeVariant *	thisVariant ()
const DocNodeVariant *	thisVariant () const
void	setThisVariant (DocNodeVariant *thisVariant)
DocParser *	parser ()
const DocParser *	parser () const
void	setParent (DocNodeVariant *parent)
bool	isPreformatted () const

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

Detailed Description

Node representing a uml file.

Definition at line 739 of file docnode.h.

Constructor & Destructor Documentation

DocPlantUmlFile()

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

Definition at line 1245 of file docnode.cpp.

                                                           :
  DocDiagramFileBase(parser,parent,name,context,srcFile,srcLine)
{
  p->relPath = parser->context.relPath;
}

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

Member Function Documentation

parse()

bool DocPlantUmlFile::parse

(

)

Definition at line 1252 of file docnode.cpp.

{
  bool ok = false;
  parser()->defaultHandleTitleAndSize(CommandType::CMD_PLANTUMLFILE,thisVariant(),children(),p->width,p->height);
 
  bool ambig = false;
  FileDef *fd = Doxygen::plantUmlFileNameLinkedMap->findFileDef(p->name,ambig);
  if (fd==nullptr && !p->name.endsWith(".puml")) // try with .puml extension as well
  {
    fd = Doxygen::plantUmlFileNameLinkedMap->findFileDef(p->name+".puml",ambig);
    if (fd==nullptr && !p->name.endsWith(".pu")) // try with .pu extension as well
    {
      fd = Doxygen::plantUmlFileNameLinkedMap->findFileDef(p->name+".pu",ambig);
    }
  }
  if (fd)
  {
    p->file = fd->absFilePath();
    ok = true;
    if (ambig)
    {
      warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"included uml file name '{}' is ambiguous.\n"
           "Possible candidates:\n{}",p->name,
           Doxygen::plantUmlFileNameLinkedMap->showFileDefMatches(p->name)
          );
    }
  }
  else
  {
    warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"included uml file '{}' is not found "
           "in any of the paths specified via PLANTUMLFILE_DIRS!",p->name);
  }
  return ok;
}

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

---

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

• src/docnode.h
• src/docnode.cpp