The DocMscFile Class Reference

Node representing a msc file. More...

Declaration

class DocMscFile { ... }

Included Headers

#include <src/docnode.h>

Base class

class	DocDiagramFileBase

Public Constructors Index

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

Definition at line 721 of file docnode.h.

Public Constructors

DocMscFile()

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

Declaration at line 724 of file docnode.h, definition at line 1128 of file docnode.cpp.

1128DocMscFile::DocMscFile(DocParser *parser,DocNodeVariant *parent,const QCString &name,const QCString &context,

1129 const QCString &srcFile, int srcLine) :

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

1131{

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

1133}

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

Public Member Functions

parse()

bool DocMscFile::parse ()

Declaration at line 726 of file docnode.h, definition at line 1135 of file docnode.cpp.

1135bool DocMscFile::parse()

1136{

1137 bool ok = false;

1138 parser()->defaultHandleTitleAndSize(CommandType::CMD_MSCFILE,thisVariant(),children(),p->width,p->height);

1139

1140 bool ambig = false;

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

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

1143 {

1144 fd = findFileDef(Doxygen::mscFileNameLinkedMap,p->name+".msc",ambig);

1145 }

1146 if (fd)

1147 {

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

1149 ok = true;

1150 if (ambig)

1151 {

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

1153 "Possible candidates:\n{}",qPrint(p->name),

1154 qPrint(showFileDefMatches(Doxygen::mscFileNameLinkedMap,p->name))

1155 );

1156 }

1157 }

1158 else

1159 {

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

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

1162 }

1163 return ok;

1164}

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:

• docnode.cpp
• docnode.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.