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 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 dot file.

Definition at line 712 of file docnode.h.

Constructor & Destructor Documentation

DocDotFile()

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

Definition at line 1125 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 DocDotFile::parse

(

)

Definition at line 1132 of file docnode.cpp.

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

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:

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