MarkdownOutlineParser类 参考

#include <markdown.h>

类 MarkdownOutlineParser 继承关系图:

MarkdownOutlineParser 的协作图:

类
struct	Private

Public 成员函数
	MarkdownOutlineParser ()
virtual	~MarkdownOutlineParser ()
void	parseInput (const QCString &fileName, const char *fileBuf, const std::shared_ptr< Entry > &root, ClangTUParser *clangParser)
	Parses a single input file with the goal to build an Entry tree. 更多...
bool	needsPreprocessing (const QCString &) const
	Returns TRUE if the language identified by extension needs the C preprocessor to be run before feed the result to the input parser. 更多...
void	parsePrototype (const QCString &text)
	Callback function called by the comment block scanner. 更多...
Public 成员函数 继承自 OutlineParserInterface
virtual	~OutlineParserInterface ()

Private 属性
std::unique_ptr< Private >	p

详细描述

在文件 markdown.h 第 91 行定义.

构造及析构函数说明

MarkdownOutlineParser()

MarkdownOutlineParser::MarkdownOutlineParser

(

)

在文件 markdown.cpp 第 3081 行定义.

                                             : p(std::make_unique<Private>())
{
}

~MarkdownOutlineParser()

MarkdownOutlineParser::~MarkdownOutlineParser ( )

virtual

在文件 markdown.cpp 第 3085 行定义.

{
}

成员函数说明

needsPreprocessing()

bool MarkdownOutlineParser::needsPreprocessing ( const QCString &  extension ) const

inlinevirtual

Returns TRUE if the language identified by extension needs the C preprocessor to be run before feed the result to the input parser.

参见

parseInput()

实现了 OutlineParserInterface.

在文件 markdown.h 第 100 行定义.

{ return FALSE; }

引用了 FALSE.

parseInput()

void MarkdownOutlineParser::parseInput ( const QCString &  fileName, const char *  fileBuf, const std::shared_ptr< Entry > &  root, ClangTUParser *  clangParser  )

virtual

Parses a single input file with the goal to build an Entry tree.

参数

[in]	fileName	The full name of the file.
[in]	fileBuf	The contents of the file (zero terminated).
[in,out]	root	The root of the tree of Entry *nodes representing the information extracted from the file.
[in]	clangParser	The clang translation unit parser object or nullptr if disabled.

实现了 OutlineParserInterface.

在文件 markdown.cpp 第 3089 行定义.

{
  std::shared_ptr<Entry> current = std::make_shared<Entry>();
  int prepend = 0; // number of empty lines in front
  current->lang = SrcLangExt_Markdown;
  current->fileName = fileName;
  current->docFile  = fileName;
  current->docLine  = 1;
  QCString docs = fileBuf;
  Debug::print(Debug::Markdown,0,"======== Markdown =========\n---- input ------- \n%s\n",qPrint(fileBuf));
  QCString id;
  Markdown markdown(fileName,1,0);
  QCString title=markdown.extractPageTitle(docs,id,prepend).stripWhiteSpace();
  if (id.startsWith("autotoc_md")) id = "";
  int indentLevel=title.isEmpty() ? 0 : -1;
  markdown.setIndentLevel(indentLevel);
  QCString fn      = FileInfo(fileName.str()).fileName();
  QCString titleFn = stripExtensionGeneral(fn,getFileNameExtension(fn));
  QCString mdfileAsMainPage = Config_getString(USE_MDFILE_AS_MAINPAGE);
  bool wasEmpty = id.isEmpty();
  if (wasEmpty) id = markdownFileNameToId(fileName);
  if (!isExplicitPage(docs))
  {
    if (!mdfileAsMainPage.isEmpty() &&
        (fn==mdfileAsMainPage || // name reference
         FileInfo(fileName.str()).absFilePath()==
         FileInfo(mdfileAsMainPage.str()).absFilePath()) // file reference with path
       )
    {
      docs.prepend("@anchor " + id + "\\ilinebr ");
      docs.prepend("@mainpage "+title+"\\ilinebr ");
    }
    else if (id=="mainpage" || id=="index")
    {
      if (title.isEmpty()) title = titleFn;
      docs.prepend("@anchor " + id + "\\ilinebr ");
      docs.prepend("@mainpage "+title+"\\ilinebr ");
    }
    else
    {
      if (title.isEmpty()) {title = titleFn;prepend=0;}
      if (!wasEmpty) docs.prepend("@anchor " +  markdownFileNameToId(fileName) + "\\ilinebr ");
      docs.prepend("@page "+id+" "+title+"\\ilinebr ");
    }
    for (int i = 0; i < prepend; i++) docs.prepend("\n");
  }
  int lineNr=1;
 
  p->commentScanner.enterFile(fileName,lineNr);
  Protection prot=Public;
  bool needsEntry = FALSE;
  int position=0;
  QCString processedDocs = markdown.process(docs,lineNr,true);
  while (p->commentScanner.parseCommentBlock(
        this,
        current.get(),
        processedDocs,
        fileName,
        lineNr,
        FALSE,     // isBrief
        FALSE,     // javadoc autobrief
        FALSE,     // inBodyDocs
        prot,      // protection
        position,
        needsEntry,
        true))
  {
    if (needsEntry)
    {
      QCString docFile = current->docFile;
      root->moveToSubEntryAndRefresh(current);
      current->lang = SrcLangExt_Markdown;
      current->docFile = docFile;
      current->docLine = lineNr;
    }
  }
  if (needsEntry)
  {
    root->moveToSubEntryAndKeep(current);
  }
  p->commentScanner.leaveFile(fileName,lineNr);
}

引用了 FileInfo::absFilePath(), Config_getString, Markdown::extractPageTitle(), FALSE, FileInfo::fileName(), getFileNameExtension(), QCString::isEmpty(), isExplicitPage(), Debug::Markdown, markdownFileNameToId(), p, QCString::prepend(), Debug::print(), Markdown::process(), Public, qPrint(), Markdown::setIndentLevel(), SrcLangExt_Markdown, QCString::str(), stripExtensionGeneral() , 以及 QCString::stripWhiteSpace().

parsePrototype()

void MarkdownOutlineParser::parsePrototype ( const QCString &  text )

virtual

Callback function called by the comment block scanner.

It provides a string text containing the prototype of a function or variable. The parser should parse this and store the information in the Entry node that corresponds with the node for which the comment block parser was invoked.

实现了 OutlineParserInterface.

在文件 markdown.cpp 第 3175 行定义.

{
  Doxygen::parserManager->getOutlineParser("*.cpp")->parsePrototype(text);
}

引用了 ParserManager::getOutlineParser() , 以及 Doxygen::parserManager.

类成员变量说明

p

std::unique_ptr<Private> MarkdownOutlineParser::p

private

在文件 markdown.h 第 103 行定义.

被这些函数引用 parseInput().

---

该类的文档由以下文件生成:

• src/markdown.h
• src/markdown.cpp