DocMscFile Class Reference

Node representing a msc file. More...

#include <src/docnode.h>

Inheritance diagram for DocMscFile:

Collaboration diagram for DocMscFile:

Public Member Functions
	DocMscFile (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 msc file.

Definition at line 721 of file docnode.h.

Constructor & Destructor Documentation

DocMscFile()

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

Definition at line 1163 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 DocMscFile::parse

(

)

Definition at line 1170 of file docnode.cpp.

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

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

---

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

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