singlecomment.h File Reference

#include <string>

Include dependency graph for singlecomment.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	generateHtmlForComment (const std::string &fileName, const std::string &text)
	Helper for implemented the -c option of doxygen, which produces HTML output for a given doxygen formatted string.

Function Documentation

generateHtmlForComment()

void generateHtmlForComment	(	const std::string &	fileName,
		const std::string &	text )

Helper for implemented the -c option of doxygen, which produces HTML output for a given doxygen formatted string.

Definition at line 54 of file singlecomment.cpp.

{
  QCString fileName = "index.html";
  std::shared_ptr<Entry> root = std::make_shared<Entry>();
 
  // 1. Pass input through commentcnv
  std::string convBuf;
  convBuf.reserve(text.size()+1024);
  convertCppComments(text,convBuf,"input.md");
 
  // 2. Pass result through commentscan
  MarkdownOutlineParser markdownParser;
  CommentScanner scanner;
  int lineNr=1;
  scanner.enterFile(fileName,lineNr);
  int pos=0;
  bool needsEntry=false;
  GuardedSectionStack guards;
  Markdown markdown(fileName,1,0);
  QCString processedDocs = markdown.process(convBuf.data(),lineNr,true);
  std::shared_ptr<Entry> current = std::make_shared<Entry>();
  current->lang = SrcLangExt::Markdown;
  current->fileName = fn;
  current->docFile  = fn;
  current->docLine  = 1;
  auto prot = Protection::Public;
  while (scanner.parseCommentBlock(&markdownParser,
        current.get(),
        processedDocs,
        fileName,lineNr,
        false, // isBrief
        false, // isAutoBriefOn
        false, // isInbody
        prot,
        pos,
        needsEntry,
        true,  // markdownSupport
        &guards))
  {
    if (needsEntry)
    {
      QCString docFile = current->docFile;
      root->moveToSubEntryAndRefresh(current);
      current->lang = SrcLangExt::Markdown;
      current->docFile = docFile;
      current->docLine = lineNr;
    }
  }
  root->moveToSubEntryAndKeep(current);
  scanner.leaveFile(fileName,lineNr);
 
  // 3. Pass result through docparser
  for (const auto &child : root->children())
  {
    if (!child->brief.isEmpty())
    {
      generateHtmlOutput(fn,child->brief);
    }
    if (!child->doc.isEmpty())
    {
      generateHtmlOutput(fn,child->doc);
    }
  }
}

References convertCppComments(), CommentScanner::enterFile(), generateHtmlOutput(), CommentScanner::leaveFile(), CommentScanner::parseCommentBlock(), and Markdown::process().

Referenced by parseInput().