The `ManGenerator` Class Reference

Generator for Man page output. More...

Declaration

class ManGenerator { ... }

Included Headers

Base classes

class	OutputGenerator
	Base class for shared implementation for all output generators. More...

class	OutputGenIntf
	Abstract interface for output generators. More...

Public Constructors Index

	ManGenerator ()


	ManGenerator (const ManGenerator &)


	ManGenerator (ManGenerator &&)=delete

Public Destructor Index

	~ManGenerator ()

Public Operators Index

ManGenerator &	operator= (const ManGenerator &)


ManGenerator &	operator= (ManGenerator &&)=delete

Public Member Functions Index

void	clearBuffer ()


void	newParagraph ()


OutputType	type () const override


std::unique_ptr< OutputGenIntf >	clone () override


void	addCodeGen (OutputCodeList &list) override


void	cleanup () override


void	writeDoc (const IDocNodeAST ast, const Definition , const MemberDef *, int) override


void	startFile (const QCString &name, const QCString &manName, const QCString &title, int id, int hierarchyLevel) override


void	endFile () override


void	writeSearchInfo () override


void	writeFooter (const QCString &) override


void	startPageDoc (const QCString &) override


void	endPageDoc () override


void	startIndexSection (IndexSection) override


void	endIndexSection (IndexSection) override


void	writePageLink (const QCString &, bool) override


void	startProjectNumber () override


void	endProjectNumber () override


void	writeStyleInfo (int) override


void	startTitleHead (const QCString &) override


void	endTitleHead (const QCString &, const QCString &) override


void	startParagraph (const QCString &classDef) override


void	endParagraph () override


void	writeString (const QCString &text) override


void	startIndexListItem () override


void	endIndexListItem () override


void	startIndexList () override


void	endIndexList () override


void	startIndexKey () override


void	endIndexKey () override


void	startIndexValue (bool) override


void	endIndexValue (const QCString &, bool) override


void	startItemList () override


void	endItemList () override


void	startIndexItem (const QCString &ref, const QCString &file) override


void	endIndexItem (const QCString &ref, const QCString &file) override


void	docify (const QCString &text) override


void	writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name) override


void	startTextLink (const QCString &, const QCString &) override


void	endTextLink () override


void	startTypewriter () override


void	endTypewriter () override


void	startGroupHeader (const QCString &, int) override


void	endGroupHeader (int) override


void	startMemberSections () override


void	endMemberSections () override


void	startHeaderSection () override


void	endHeaderSection () override


void	startMemberHeader (const QCString &, int) override


void	endMemberHeader () override


void	insertMemberAlign (bool) override


void	insertMemberAlignLeft (MemberItemType, bool) override


void	startMemberSubtitle () override


void	endMemberSubtitle () override


void	startItemListItem () override


void	endItemListItem () override


void	startMemberDocList () override


void	endMemberDocList () override


void	startMemberList () override


void	endMemberList () override


void	startInlineHeader () override


void	endInlineHeader () override


void	startAnonTypeScope (int) override


void	endAnonTypeScope (int) override


void	startMemberItem (const QCString &, MemberItemType, const QCString &) override


void	endMemberItem (MemberItemType) override


void	startMemberTemplateParams () override


void	endMemberTemplateParams (const QCString &, const QCString &) override


void	startCompoundTemplateParams () override


void	endCompoundTemplateParams () override


void	startMemberGroupHeader (const QCString &, bool) override


void	endMemberGroupHeader () override


void	startMemberGroupDocs () override


void	endMemberGroupDocs () override


void	startMemberGroup () override


void	endMemberGroup (bool) override


void	writeRuler () override


void	writeAnchor (const QCString &, const QCString &) override


void	startEmphasis () override


void	endEmphasis () override


void	startBold () override


void	endBold () override


void	startBoldEmphasis ()


void	endBoldEmphasis ()


void	lineBreak (const QCString &) override


void	writeChar (char c) override


void	startMemberDoc (const QCString &, const QCString &, const QCString &, const QCString &, int, int, bool) override


void	endMemberDoc (bool) override


void	startDoxyAnchor (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) override


void	endDoxyAnchor (const QCString &, const QCString &) override


void	addLabel (const QCString &, const QCString &) override


void	writeLatexSpacing () override


void	writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &name) override


void	startCenter () override


void	endCenter () override


void	startSmall () override


void	endSmall () override


void	startMemberDescription (const QCString &, const QCString &, bool) override


void	endMemberDescription () override


void	startMemberDeclaration () override


void	endMemberDeclaration (const QCString &, const QCString &) override


void	writeInheritedSectionTitle (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) override


void	startExamples () override


void	endExamples () override


void	startDescForItem () override


void	endDescForItem () override


void	startSection (const QCString &, const QCString &, SectionType) override


void	endSection (const QCString &, SectionType) override


void	addIndexItem (const QCString &, const QCString &) override


void	startIndent () override


void	endIndent () override


void	writeSynopsis () override


void	startClassDiagram () override


void	endClassDiagram (const ClassDiagram &, const QCString &, const QCString &) override


void	startPageRef () override


void	endPageRef (const QCString &, const QCString &) override


void	startQuickIndices () override


void	endQuickIndices () override


void	writeSplitBar (const QCString &, const QCString &) override


void	writeNavigationPath (const QCString &) override


void	writeLogo () override


void	writeQuickLinks (HighlightedItem, const QCString &, bool) override


void	writeSummaryLink (const QCString &, const QCString &, const QCString &, bool) override


void	writePageOutline () override


void	startContents () override


void	endContents () override


void	writeNonBreakableSpace (int n) override


void	startDescTable (const QCString &title, const bool hasInits) override


void	endDescTable () override


void	startDescTableTitle () override


void	endDescTableTitle () override


void	startDescTableRow () override


void	endDescTableRow () override


void	startDescTableInit () override


void	endDescTableInit () override


void	startDescTableData () override


void	endDescTableData () override


void	startDotGraph () override


void	endDotGraph (DotClassGraph &) override


void	startInclDepGraph () override


void	endInclDepGraph (DotInclDepGraph &) override


void	startGroupCollaboration () override


void	endGroupCollaboration (DotGroupCollaboration &) override


void	startCallGraph () override


void	endCallGraph (DotCallGraph &) override


void	startDirDepGraph () override


void	endDirDepGraph (DotDirDeps &) override


void	writeGraphicalHierarchy (DotGfxHierarchyTable &) override


void	startTextBlock (bool) override


void	endTextBlock (bool) override


void	lastIndexPage () override


void	startMemberDocPrefixItem () override


void	endMemberDocPrefixItem () override


void	startMemberDocName (bool) override


void	endMemberDocName () override


void	startParameterType (bool, const QCString &) override


void	endParameterType () override


void	startParameterName (bool) override


void	endParameterName () override


void	startParameterExtra () override


void	endParameterExtra (bool, bool, bool) override


void	startParameterDefVal (const char *s) override


void	endParameterDefVal () override


void	startParameterList (bool) override


void	endParameterList () override


void	exceptionEntry (const QCString &, bool) override


void	startConstraintList (const QCString &) override


void	startConstraintParam () override


void	endConstraintParam () override


void	startConstraintType () override


void	endConstraintType () override


void	startConstraintDocs () override


void	endConstraintDocs () override


void	endConstraintList () override


void	startMemberDocSimple (bool) override


void	endMemberDocSimple (bool) override


void	startInlineMemberType () override


void	endInlineMemberType () override


void	startInlineMemberName () override


void	endInlineMemberName () override


void	startInlineMemberDoc () override


void	endInlineMemberDoc () override


void	startLabels () override


void	writeLabel (const QCString &l, bool isLast) override


void	endLabels () override


void	startLocalToc (int) override


void	endLocalToc () override


void	startTocEntry (const SectionInfo *) override


void	endTocEntry (const SectionInfo *) override


void	startPlainFile (const QCString &name) override


void	endPlainFile () override

Private Member Functions Index

void	startTitle ()


void	endTitle ()

Private Member Attributes Index

bool	m_firstCol = true


int	m_col = 0


bool	m_paragraph = true


bool	m_upperCase = false


bool	m_insideTabbing = false


bool	m_inHeader = false


std::unique_ptr< OutputCodeList >	m_codeList


ManCodeGenerator *	m_codeGen

Public Static Functions Index

static void	init ()

Description

Generator for Man page output.

Definition at line 68 of file mangen.h.

Public Constructors

ManGenerator()

ManGenerator::ManGenerator ()

Declaration at line 71 of file mangen.h, definition at line 227 of file mangen.cpp.

227ManGenerator::ManGenerator()

228 : OutputGenerator(Config_getString(MAN_OUTPUT)+"/"+getSubdir())

229 , m_codeList(std::make_unique<OutputCodeList>())

230{

231 m_codeGen = m_codeList->add<ManCodeGenerator>(&m_t);

232}

References Config_getString, getSubdir, m_codeGen, m_codeList, OutputGenerator::m_t and OutputGenerator::OutputGenerator.

Referenced by ManGenerator, ManGenerator, operator= and operator=.

ManGenerator()

ManGenerator::ManGenerator (const ManGenerator & og)

Declaration at line 72 of file mangen.h, definition at line 234 of file mangen.cpp.

234ManGenerator::ManGenerator(const ManGenerator &og) : OutputGenerator(og.m_dir), OutputGenIntf()

235{

236 m_codeList = std::make_unique<OutputCodeList>(*og.m_codeList);

237 m_codeGen = m_codeList->get<ManCodeGenerator>(OutputType::Man);

238 m_codeGen->setTextStream(&m_t);

239 m_firstCol = og.m_firstCol;

240 m_col = og.m_col;

241 m_paragraph = og.m_paragraph;

242 m_upperCase = og.m_upperCase;

243 m_insideTabbing = og.m_insideTabbing;

244 m_inHeader = og.m_inHeader;

245}

References m_codeGen, m_codeList, m_col, OutputGenerator::m_dir, m_firstCol, m_inHeader, m_insideTabbing, m_paragraph, OutputGenerator::m_t, m_upperCase, Man, ManGenerator and OutputGenerator::OutputGenerator.

ManGenerator()

ManGenerator::ManGenerator (ManGenerator &&)

delete

Definition at line 74 of file mangen.h.

Reference ManGenerator.

Public Destructor

~ManGenerator()

ManGenerator::~ManGenerator ()

Definition at line 76 of file mangen.h.

Public Operators

operator=()

ManGenerator & ManGenerator::operator= (const ManGenerator & og)

Declaration at line 73 of file mangen.h, definition at line 247 of file mangen.cpp.

247ManGenerator &ManGenerator::operator=(const ManGenerator &og)

248{

249 if (this!=&og)

250 {

251 m_dir = og.m_dir;

252 m_codeList = std::make_unique<OutputCodeList>(*og.m_codeList);

253 m_codeGen = m_codeList->get<ManCodeGenerator>(OutputType::Man);

254 m_codeGen->setTextStream(&m_t);

255 m_firstCol = og.m_firstCol;

256 m_col = og.m_col;

257 m_paragraph = og.m_paragraph;

258 m_upperCase = og.m_upperCase;

259 m_insideTabbing = og.m_insideTabbing;

260 m_inHeader = og.m_inHeader;

261 }

262 return *this;

263}

References m_codeGen, m_codeList, m_col, OutputGenerator::m_dir, m_firstCol, m_inHeader, m_insideTabbing, m_paragraph, OutputGenerator::m_t, m_upperCase, Man and ManGenerator.

operator=()

ManGenerator & ManGenerator::operator= (ManGenerator &&)

delete

Definition at line 75 of file mangen.h.

Reference ManGenerator.

Public Member Functions

addCodeGen()

void ManGenerator::addCodeGen (OutputCodeList & list)

virtual

Declaration at line 86 of file mangen.h, definition at line 267 of file mangen.cpp.

267void ManGenerator::addCodeGen(OutputCodeList &list)

268{

269 list.add<ManCodeGeneratorDefer>(m_codeGen);

270}

References OutputCodeList::add and m_codeGen.

addIndexItem()

void ManGenerator::addIndexItem (const QCString &, const QCString &)

inline virtual

Definition at line 199 of file mangen.h.

199 void addIndexItem(const QCString &,const QCString &) override {}

addLabel()

void ManGenerator::addLabel (const QCString &, const QCString &)

virtual

Declaration at line 178 of file mangen.h, definition at line 563 of file mangen.cpp.

563void ManGenerator::addLabel(const QCString &,const QCString &)

564{

565}

cleanup()

void ManGenerator::cleanup ()

virtual

Declaration at line 87 of file mangen.h, definition at line 289 of file mangen.cpp.

289void ManGenerator::cleanup()

290{

291 QCString dname = Config_getString(MAN_OUTPUT);

292 Dir d(dname.str());

293 clearSubDirs(d);

294}

References clearSubDirs, Config_getString and QCString::str.

clearBuffer()

void ManGenerator::clearBuffer ()

Definition at line 79 of file mangen.h.

clone()

std::unique_ptr< OutputGenIntf > ManGenerator::clone ()

inline virtual

Definition at line 85 of file mangen.h.

85 std::unique_ptr<OutputGenIntf> clone() override { return std::make_unique<ManGenerator>(*this); }

docify()

void ManGenerator::docify (const QCString & text)

virtual

Declaration at line 121 of file mangen.h, definition at line 459 of file mangen.cpp.

459void ManGenerator::docify(const QCString &str)

460{

461 if (!str.isEmpty())

462 {

463 const char *p=str.data();

464 char c=0;

465 while ((c=*p++))

466 {

467 switch(c)

468 {

469 case '-': m_t << "\\-"; break; // see bug747780

470 case '.': m_t << "\\&."; break; // see bug652277

471 case '\\': m_t << "\\\\"; m_col++; break;

472 case '\n': m_t << "\n"; m_col=0; break;

473 case '\"': c = '\''; // no break!

474 default: m_t << c; m_col++; break;

475 }

476 }

477 m_firstCol=(c=='\n');

478 //printf("%s",str);fflush(stdout);

479 }

480 m_paragraph=FALSE;

481}

References QCString::data, FALSE, QCString::isEmpty, m_col, m_firstCol, m_paragraph and OutputGenerator::m_t.

Referenced by startConstraintList, startDescTable, startExamples, startMemberDocSimple, startParameterDefVal, writeObjectLink and writeString.

endAnonTypeScope()

void ManGenerator::endAnonTypeScope (int indentLevel)

virtual

Declaration at line 149 of file mangen.h, definition at line 614 of file mangen.cpp.

614void ManGenerator::endAnonTypeScope(int indentLevel)

615{

616 if (indentLevel==0)

617 {

618 m_insideTabbing=FALSE;

619 }

620}

References FALSE and m_insideTabbing.

endBold()

void ManGenerator::endBold ()

inline virtual

Definition at line 169 of file mangen.h.

169 void endBold() override { m_t << "\\fP"; m_firstCol=FALSE; }

References FALSE, m_firstCol and OutputGenerator::m_t.

Referenced by startConstraintList, startDescTable, startExamples and writeObjectLink.

endBoldEmphasis()

void ManGenerator::endBoldEmphasis ()

inline

Definition at line 171 of file mangen.h.

171 void endBoldEmphasis() { m_t << "\\fP"; m_firstCol=FALSE; }

References FALSE, m_firstCol and OutputGenerator::m_t.

Referenced by endDescTableTitle.

endCallGraph()

void ManGenerator::endCallGraph (DotCallGraph &)

inline virtual

Definition at line 237 of file mangen.h.

237 void endCallGraph(DotCallGraph &) override {}

endCenter()

void ManGenerator::endCenter ()

inline virtual

Definition at line 184 of file mangen.h.

184 void endCenter() override {}

endClassDiagram()

void ManGenerator::endClassDiagram (const ClassDiagram &, const QCString &, const QCString &)

inline virtual

Definition at line 204 of file mangen.h.

204 void endClassDiagram(const ClassDiagram &,const QCString &,const QCString &) override {}

endCompoundTemplateParams()

void ManGenerator::endCompoundTemplateParams ()

virtual

Declaration at line 155 of file mangen.h, definition at line 580 of file mangen.cpp.

580void ManGenerator::endCompoundTemplateParams()

581{

582 m_t << "\"";

583}

Reference OutputGenerator::m_t.

endConstraintDocs()

void ManGenerator::endConstraintDocs ()

virtual

Declaration at line 268 of file mangen.h, definition at line 816 of file mangen.cpp.

816void ManGenerator::endConstraintDocs()

817{

818 m_t << "\n"; m_firstCol=TRUE;

819}

References m_firstCol, OutputGenerator::m_t and TRUE.

endConstraintList()

void ManGenerator::endConstraintList ()

virtual

Declaration at line 269 of file mangen.h, definition at line 821 of file mangen.cpp.

821void ManGenerator::endConstraintList()

822{

823}

endConstraintParam()

void ManGenerator::endConstraintParam ()

virtual

Declaration at line 264 of file mangen.h, definition at line 795 of file mangen.cpp.

795void ManGenerator::endConstraintParam()

796{

797 endEmphasis();

798 endItemListItem();

799 m_t << " : ";

800}

References endEmphasis, endItemListItem and OutputGenerator::m_t.

endConstraintType()

void ManGenerator::endConstraintType ()

virtual

Declaration at line 266 of file mangen.h, definition at line 807 of file mangen.cpp.

807void ManGenerator::endConstraintType()

808{

809 endEmphasis();

810}

Reference endEmphasis.

endContents()

void ManGenerator::endContents ()

inline virtual

Definition at line 216 of file mangen.h.

216 void endContents() override {}

endDescForItem()

void ManGenerator::endDescForItem ()

virtual

Declaration at line 196 of file mangen.h, definition at line 602 of file mangen.cpp.

602void ManGenerator::endDescForItem()

603{

604}

Referenced by endDescTable.

endDescTable()

void ManGenerator::endDescTable ()

virtual

Declaration at line 220 of file mangen.h, definition at line 758 of file mangen.cpp.

758void ManGenerator::endDescTable()

759{

760 endDescForItem();

761}

Reference endDescForItem.

endDescTableData()

void ManGenerator::endDescTableData ()

inline virtual

Definition at line 228 of file mangen.h.

228 void endDescTableData() override {}

endDescTableInit()

void ManGenerator::endDescTableInit ()

inline virtual

Definition at line 226 of file mangen.h.

226 void endDescTableInit() override {};

endDescTableRow()

void ManGenerator::endDescTableRow ()

inline virtual

Definition at line 224 of file mangen.h.

224 void endDescTableRow() override {}

endDescTableTitle()

void ManGenerator::endDescTableTitle ()

inline virtual

Definition at line 222 of file mangen.h.

222 void endDescTableTitle() override { endBoldEmphasis(); }

Reference endBoldEmphasis.

endDirDepGraph()

void ManGenerator::endDirDepGraph (DotDirDeps &)

inline virtual

Definition at line 239 of file mangen.h.

239 void endDirDepGraph(DotDirDeps &) override {}

endDotGraph()

void ManGenerator::endDotGraph (DotClassGraph &)

inline virtual

Definition at line 231 of file mangen.h.

231 void endDotGraph(DotClassGraph &) override {}

endDoxyAnchor()

void ManGenerator::endDoxyAnchor (const QCString &, const QCString &)

inline virtual

Definition at line 177 of file mangen.h.

177 void endDoxyAnchor(const QCString &,const QCString &) override {}

endEmphasis()

void ManGenerator::endEmphasis ()

inline virtual

Definition at line 167 of file mangen.h.

167 void endEmphasis() override { m_t << "\\fP"; m_firstCol=FALSE; }

References FALSE, m_firstCol and OutputGenerator::m_t.

Referenced by endConstraintParam and endConstraintType.

endExamples()

void ManGenerator::endExamples ()

virtual

Declaration at line 194 of file mangen.h, definition at line 739 of file mangen.cpp.

739void ManGenerator::endExamples()

740{

741}

endFile()

void ManGenerator::endFile ()

virtual

Declaration at line 90 of file mangen.h, definition at line 343 of file mangen.cpp.

343void ManGenerator::endFile()

344{

345 m_t << "\n";

346 endPlainFile();

347}

References endPlainFile and OutputGenerator::m_t.

endGroupCollaboration()

void ManGenerator::endGroupCollaboration (DotGroupCollaboration &)

inline virtual

Definition at line 235 of file mangen.h.

235 void endGroupCollaboration(DotGroupCollaboration &) override {}

endGroupHeader()

void ManGenerator::endGroupHeader (int)

virtual

Declaration at line 129 of file mangen.h, definition at line 438 of file mangen.cpp.

438void ManGenerator::endGroupHeader(int)

439{

440 m_t << "\"\n.PP \n";

441 m_firstCol=TRUE;

442 m_paragraph=TRUE;

443 m_upperCase=FALSE;

444}

References FALSE, m_firstCol, m_paragraph, OutputGenerator::m_t, m_upperCase and TRUE.

Referenced by endSection.

endHeaderSection()

void ManGenerator::endHeaderSection ()

virtual

Declaration at line 133 of file mangen.h, definition at line 913 of file mangen.cpp.

913void ManGenerator::endHeaderSection()

914{

915}

endInclDepGraph()

void ManGenerator::endInclDepGraph (DotInclDepGraph &)

inline virtual

Definition at line 233 of file mangen.h.

233 void endInclDepGraph(DotInclDepGraph &) override {}

endIndent()

void ManGenerator::endIndent ()

inline virtual

Definition at line 201 of file mangen.h.

201 void endIndent() override {}

endIndexItem()

void ManGenerator::endIndexItem (const QCString & ref, const QCString & file)

virtual

Declaration at line 120 of file mangen.h, definition at line 415 of file mangen.cpp.

415void ManGenerator::endIndexItem(const QCString &,const QCString &)

416{

417}

endIndexKey()

void ManGenerator::endIndexKey ()

inline virtual

Definition at line 114 of file mangen.h.

114 void endIndexKey() override {}

endIndexList()

void ManGenerator::endIndexList ()

inline virtual

Definition at line 112 of file mangen.h.

112 void endIndexList() override { newParagraph(); }

Reference newParagraph.

endIndexListItem()

void ManGenerator::endIndexListItem ()

inline virtual

Definition at line 110 of file mangen.h.

110 void endIndexListItem() override {}

endIndexSection()

void ManGenerator::endIndexSection (IndexSection)

inline virtual

Definition at line 98 of file mangen.h.

98 void endIndexSection(IndexSection) override {}

endIndexValue()

void ManGenerator::endIndexValue (const QCString &, bool)

inline virtual

Definition at line 116 of file mangen.h.

116 void endIndexValue(const QCString &,bool) override {}

endInlineHeader()

void ManGenerator::endInlineHeader ()

virtual

Declaration at line 147 of file mangen.h, definition at line 835 of file mangen.cpp.

835void ManGenerator::endInlineHeader()

836{

837 m_t << "\\fP\"\n" << ".in +1c\n";

838 m_firstCol = FALSE;

839}

References FALSE, m_firstCol and OutputGenerator::m_t.

endInlineMemberDoc()

void ManGenerator::endInlineMemberDoc ()

virtual

Declaration at line 278 of file mangen.h, definition at line 891 of file mangen.cpp.

891void ManGenerator::endInlineMemberDoc()

892{

893 if (!m_firstCol) m_t << "\n";

894 m_t << ".br\n";

895 m_t << ".PP\n";

896 m_firstCol=TRUE;

897}

References m_firstCol, OutputGenerator::m_t and TRUE.

endInlineMemberName()

void ManGenerator::endInlineMemberName ()

virtual

Declaration at line 276 of file mangen.h, definition at line 882 of file mangen.cpp.

882void ManGenerator::endInlineMemberName()

883{

884 m_t << "\\fP ";

885}

Reference OutputGenerator::m_t.

endInlineMemberType()

void ManGenerator::endInlineMemberType ()

virtual

Declaration at line 274 of file mangen.h, definition at line 872 of file mangen.cpp.

872void ManGenerator::endInlineMemberType()

873{

874 m_t << " ";

875}

Reference OutputGenerator::m_t.

endItemList()

void ManGenerator::endItemList ()

inline virtual

Definition at line 118 of file mangen.h.

118 void endItemList() override { newParagraph(); }

Reference newParagraph.

endItemListItem()

void ManGenerator::endItemListItem ()

virtual

Declaration at line 141 of file mangen.h, definition at line 519 of file mangen.cpp.

519void ManGenerator::endItemListItem()

520{

521}

Referenced by endConstraintParam and startDescTableTitle.

endLabels()

void ManGenerator::endLabels ()

virtual

Declaration at line 282 of file mangen.h, definition at line 909 of file mangen.cpp.

909void ManGenerator::endLabels()

910{

911}

endLocalToc()

void ManGenerator::endLocalToc ()

inline virtual

Definition at line 285 of file mangen.h.

285 void endLocalToc() override {}

endMemberDeclaration()

void ManGenerator::endMemberDeclaration (const QCString &, const QCString &)

inline virtual

Definition at line 190 of file mangen.h.

190 void endMemberDeclaration(const QCString &,const QCString &) override {}

endMemberDescription()

void ManGenerator::endMemberDescription ()

inline virtual

Definition at line 188 of file mangen.h.

188 void endMemberDescription() override { m_t << "\""; m_firstCol=FALSE; }

References FALSE, m_firstCol and OutputGenerator::m_t.

endMemberDoc()

void ManGenerator::endMemberDoc (bool)

virtual

Declaration at line 175 of file mangen.h, definition at line 567 of file mangen.cpp.

567void ManGenerator::endMemberDoc(bool)

568{

569 m_t << "\"\n";

570}

Reference OutputGenerator::m_t.

endMemberDocList()

void ManGenerator::endMemberDocList ()

inline virtual

Definition at line 143 of file mangen.h.

143 void endMemberDocList() override {}

endMemberDocName()

void ManGenerator::endMemberDocName ()

inline virtual

Definition at line 249 of file mangen.h.

249 void endMemberDocName() override {}

endMemberDocPrefixItem()

void ManGenerator::endMemberDocPrefixItem ()

inline virtual

Definition at line 247 of file mangen.h.

247 void endMemberDocPrefixItem() override {}

endMemberDocSimple()

void ManGenerator::endMemberDocSimple (bool)

virtual

Declaration at line 272 of file mangen.h, definition at line 860 of file mangen.cpp.

860void ManGenerator::endMemberDocSimple(bool)

861{

862 if (!m_firstCol) m_t << "\n";

863 m_t << ".RE\n";

864 m_t << ".PP\n";

865 m_firstCol=TRUE;

866}

References m_firstCol, OutputGenerator::m_t and TRUE.

endMemberGroup()

void ManGenerator::endMemberGroup (bool)

virtual

Declaration at line 162 of file mangen.h, definition at line 676 of file mangen.cpp.

676void ManGenerator::endMemberGroup(bool)

677{

678 m_t << "\n.in -1c";

679 m_firstCol=FALSE;

680}

References FALSE, m_firstCol and OutputGenerator::m_t.

endMemberGroupDocs()

void ManGenerator::endMemberGroupDocs ()

virtual

Declaration at line 160 of file mangen.h, definition at line 666 of file mangen.cpp.

666void ManGenerator::endMemberGroupDocs()

667{

668 m_t << "\n.PP";

669}

Reference OutputGenerator::m_t.

endMemberGroupHeader()

void ManGenerator::endMemberGroupHeader ()

virtual

Declaration at line 158 of file mangen.h, definition at line 656 of file mangen.cpp.

656void ManGenerator::endMemberGroupHeader()

657{

658 m_t << "\\fP\"\n.br\n";

659 m_firstCol=TRUE;

660}

References m_firstCol, OutputGenerator::m_t and TRUE.

endMemberHeader()

void ManGenerator::endMemberHeader ()

virtual

Declaration at line 135 of file mangen.h, definition at line 452 of file mangen.cpp.

452void ManGenerator::endMemberHeader()

453{

454 m_t << "\"\n";

455 m_firstCol=TRUE;

456 m_paragraph=FALSE;

457}

References FALSE, m_firstCol, m_paragraph, OutputGenerator::m_t and TRUE.

Referenced by endSection.

endMemberItem()

void ManGenerator::endMemberItem (MemberItemType)

virtual

Declaration at line 151 of file mangen.h, definition at line 630 of file mangen.cpp.

630void ManGenerator::endMemberItem(MemberItemType)

631{

632 m_t << "\"\n.br";

633}

Reference OutputGenerator::m_t.

endMemberList()

void ManGenerator::endMemberList ()

virtual

Declaration at line 145 of file mangen.h, definition at line 643 of file mangen.cpp.

643void ManGenerator::endMemberList()

644{

645 if (!m_insideTabbing)

646 {

647 m_t << "\n.in -1c"; m_firstCol=FALSE;

648 }

649}

References FALSE, m_firstCol, m_insideTabbing and OutputGenerator::m_t.

endMemberSections()

void ManGenerator::endMemberSections ()

inline virtual

Definition at line 131 of file mangen.h.

131 void endMemberSections() override {}

endMemberSubtitle()

void ManGenerator::endMemberSubtitle ()

inline virtual

Definition at line 139 of file mangen.h.

139 void endMemberSubtitle() override {}

endMemberTemplateParams()

void ManGenerator::endMemberTemplateParams (const QCString &, const QCString &)

inline virtual

Definition at line 153 of file mangen.h.

153 void endMemberTemplateParams(const QCString &,const QCString &) override {}

endPageDoc()

void ManGenerator::endPageDoc ()

inline virtual

Definition at line 96 of file mangen.h.

96 void endPageDoc() override {}

endPageRef()

void ManGenerator::endPageRef (const QCString &, const QCString &)

inline virtual

Definition at line 206 of file mangen.h.

206 void endPageRef(const QCString &,const QCString &) override {}

endParagraph()

void ManGenerator::endParagraph ()

virtual

Declaration at line 107 of file mangen.h, definition at line 402 of file mangen.cpp.

402void ManGenerator::endParagraph()

403{

404}

endParameterDefVal()

void ManGenerator::endParameterDefVal ()

inline virtual

Definition at line 257 of file mangen.h.

257 void endParameterDefVal() override { endTypewriter(); }

Reference endTypewriter.

endParameterExtra()

void ManGenerator::endParameterExtra (bool last, bool, bool closeBracket)

virtual

Declaration at line 255 of file mangen.h, definition at line 932 of file mangen.cpp.

932void ManGenerator::endParameterExtra(bool last,bool /* emptyList */, bool closeBracket)

933{

934 if (last && closeBracket)

935 {

936 m_t << ")";

937 }

938}

Reference OutputGenerator::m_t.

endParameterList()

void ManGenerator::endParameterList ()

inline virtual

Definition at line 259 of file mangen.h.

259 void endParameterList() override {}

endParameterName()

void ManGenerator::endParameterName ()

inline virtual

Definition at line 253 of file mangen.h.

253 void endParameterName() override {}

endParameterType()

void ManGenerator::endParameterType ()

virtual

Declaration at line 251 of file mangen.h, definition at line 939 of file mangen.cpp.

939void ManGenerator::endParameterType()

940{

941 m_t << " ";

942}

Reference OutputGenerator::m_t.

endPlainFile()

void ManGenerator::endPlainFile ()

inline virtual

Definition at line 290 of file mangen.h.

290 void endPlainFile() override { OutputGenerator::endPlainFile(); }

Reference OutputGenerator::endPlainFile.

Referenced by endFile.

endProjectNumber()

void ManGenerator::endProjectNumber ()

inline virtual

Definition at line 101 of file mangen.h.

101 void endProjectNumber() override {}

endQuickIndices()

void ManGenerator::endQuickIndices ()

inline virtual

Definition at line 208 of file mangen.h.

208 void endQuickIndices() override {}

endSection()

void ManGenerator::endSection (const QCString &, SectionType type)

virtual

Declaration at line 198 of file mangen.h, definition at line 700 of file mangen.cpp.

700void ManGenerator::endSection(const QCString &,SectionType type)

701{

702 if( !m_inHeader )

703 {

704 switch(type.level())

705 {

706 case SectionType::Page: // fall through

707 case SectionType::Section: endGroupHeader(0); break;

708 case SectionType::Subsection: // fall through

709 case SectionType::Subsubsection: // fall through

710 case SectionType::Paragraph: // fall through

711 case SectionType::Subparagraph: // fall through

712 case SectionType::Subsubparagraph: endMemberHeader(); break;

713 default: ASSERT(0); break;

714 }

715 }

716 else

717 {

718 m_t << "\n.PP\n";

719 m_firstCol=TRUE;

720 m_paragraph=FALSE;

721 m_inHeader=FALSE;

722 }

723}

References ASSERT, endGroupHeader, endMemberHeader, FALSE, m_firstCol, m_inHeader, m_paragraph, OutputGenerator::m_t, SectionType::Page, SectionType::Paragraph, SectionType::Section, SectionType::Subparagraph, SectionType::Subsection, SectionType::Subsubparagraph, SectionType::Subsubsection, TRUE and type.

endSmall()

void ManGenerator::endSmall ()

inline virtual

Definition at line 186 of file mangen.h.

186 void endSmall() override {}

endTextBlock()

void ManGenerator::endTextBlock (bool)

inline virtual

Definition at line 243 of file mangen.h.

243 void endTextBlock(bool) override {}

endTextLink()

void ManGenerator::endTextLink ()

inline virtual

Definition at line 125 of file mangen.h.

125 void endTextLink() override {}

endTitleHead()

void ManGenerator::endTitleHead (const QCString &, const QCString & name)

virtual

Declaration at line 104 of file mangen.h, definition at line 349 of file mangen.cpp.

349void ManGenerator::endTitleHead(const QCString &,const QCString &name)

350{

351 m_t << ".TH \"" << name << "\" " << getExtension() << " \"";

352 switch (Config_getEnum(TIMESTAMP))

353 {

354 case TIMESTAMP_t::YES:

355 case TIMESTAMP_t::DATETIME:

356 m_t << dateToString(DateTimeType::DateTime) << "\" \"";

357 break;

358 case TIMESTAMP_t::DATE:

359 m_t << dateToString(DateTimeType::Date) << "\" \"";

360 break;

361 case TIMESTAMP_t::NO:

362 break;

363 }

364 if (!Config_getString(PROJECT_NUMBER).isEmpty())

365 m_t << "Version " << Config_getString(PROJECT_NUMBER) << "\" \"";

366 if (Config_getString(PROJECT_NAME).isEmpty())

367 m_t << "Doxygen";

368 else

369 m_t << Config_getString(PROJECT_NAME);

370 m_t << "\" \\\" -*- nroff -*-\n";

371 m_t << ".ad l\n";

372 m_t << ".nh\n";

373 m_t << ".SH NAME\n";

374 m_t << name;

375 m_firstCol=FALSE;

376 m_paragraph=TRUE;

377 m_inHeader=TRUE;

378}

References Config_getEnum, Config_getString, Date, DateTime, dateToString, FALSE, getExtension, m_firstCol, m_inHeader, m_paragraph, OutputGenerator::m_t and TRUE.

endTocEntry()

void ManGenerator::endTocEntry (const SectionInfo *)

inline virtual

Definition at line 287 of file mangen.h.

287 void endTocEntry(const SectionInfo *) override {}

endTypewriter()

void ManGenerator::endTypewriter ()

inline virtual

Definition at line 127 of file mangen.h.

127 void endTypewriter() override { m_t << "\\fP"; m_firstCol=FALSE; }

References FALSE, m_firstCol and OutputGenerator::m_t.

Referenced by endParameterDefVal.

exceptionEntry()

void ManGenerator::exceptionEntry (const QCString &, bool)

inline virtual

Definition at line 260 of file mangen.h.

260 void exceptionEntry(const QCString &,bool) override {}

insertMemberAlign()

void ManGenerator::insertMemberAlign (bool)

inline virtual

Definition at line 136 of file mangen.h.

136 void insertMemberAlign(bool) override {}

insertMemberAlignLeft()

void ManGenerator::insertMemberAlignLeft (MemberItemType, bool)

inline virtual

Definition at line 137 of file mangen.h.

137 void insertMemberAlignLeft(MemberItemType,bool) override {}

lastIndexPage()

void ManGenerator::lastIndexPage ()

inline virtual

Definition at line 244 of file mangen.h.

244 void lastIndexPage() override {}

lineBreak()

void ManGenerator::lineBreak (const QCString &)

inline virtual

Definition at line 172 of file mangen.h.

172 void lineBreak(const QCString &) override { m_t << "\n.br\n"; }

Reference OutputGenerator::m_t.

newParagraph()

void ManGenerator::newParagraph ()

Declaration at line 80 of file mangen.h, definition at line 380 of file mangen.cpp.

380void ManGenerator::newParagraph()

381{

382 if (!m_paragraph)

383 {

384 if (!m_firstCol) m_t << "\n";

385 m_t << ".PP\n";

386 m_firstCol=TRUE;

387 }

388 m_paragraph=TRUE;

389}

References m_firstCol, m_paragraph, OutputGenerator::m_t and TRUE.

Referenced by endIndexList and endItemList.

startAnonTypeScope()

void ManGenerator::startAnonTypeScope (int indentLevel)

virtual

Declaration at line 148 of file mangen.h, definition at line 606 of file mangen.cpp.

606void ManGenerator::startAnonTypeScope(int indentLevel)

607{

608 if (indentLevel==0)

609 {

610 m_insideTabbing=TRUE;

611 }

612}

References m_insideTabbing and TRUE.

startBold()

void ManGenerator::startBold ()

inline virtual

Definition at line 168 of file mangen.h.

168 void startBold() override { m_t << "\\fB"; m_firstCol=FALSE; }

References FALSE, m_firstCol and OutputGenerator::m_t.

Referenced by startConstraintList, startDescTable, startExamples and writeObjectLink.

startBoldEmphasis()

void ManGenerator::startBoldEmphasis ()

inline

Definition at line 170 of file mangen.h.

170 void startBoldEmphasis() { m_t << "\\f(BI"; m_firstCol=FALSE; }

References FALSE, m_firstCol and OutputGenerator::m_t.

Referenced by startDescTableTitle.

startCallGraph()

void ManGenerator::startCallGraph ()

inline virtual

Definition at line 236 of file mangen.h.

236 void startCallGraph() override {}

startCenter()

void ManGenerator::startCenter ()

inline virtual

Definition at line 183 of file mangen.h.

183 void startCenter() override {}

startClassDiagram()

void ManGenerator::startClassDiagram ()

inline virtual

Definition at line 203 of file mangen.h.

203 void startClassDiagram() override {}

startCompoundTemplateParams()

void ManGenerator::startCompoundTemplateParams ()

virtual

Declaration at line 154 of file mangen.h, definition at line 572 of file mangen.cpp.

572void ManGenerator::startCompoundTemplateParams()

573{

574 if (!m_firstCol) m_t << "\n";

575 m_t << "\n.SS \"";

576 m_firstCol=FALSE;

577 m_paragraph=FALSE;

578}

References FALSE, m_firstCol, m_paragraph and OutputGenerator::m_t.

startConstraintDocs()

void ManGenerator::startConstraintDocs ()

virtual

Declaration at line 267 of file mangen.h, definition at line 812 of file mangen.cpp.

812void ManGenerator::startConstraintDocs()

813{

814}

startConstraintList()

void ManGenerator::startConstraintList (const QCString & header)

virtual

Declaration at line 262 of file mangen.h, definition at line 775 of file mangen.cpp.

775void ManGenerator::startConstraintList(const QCString &header)

776{

777 if (!m_firstCol)

778 { m_t << "\n.PP\n";

779 m_firstCol=TRUE; m_paragraph=TRUE;

780 m_col=0;

781 }

782 m_paragraph=FALSE;

783 startBold();

784 docify(header);

785 endBold();

786 m_paragraph=TRUE;

787}

References docify, endBold, FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, startBold and TRUE.

startConstraintParam()

void ManGenerator::startConstraintParam ()

virtual

Declaration at line 263 of file mangen.h, definition at line 789 of file mangen.cpp.

789void ManGenerator::startConstraintParam()

790{

791 startItemListItem();

792 startEmphasis();

793}

References startEmphasis and startItemListItem.

startConstraintType()

void ManGenerator::startConstraintType ()

virtual

Declaration at line 265 of file mangen.h, definition at line 802 of file mangen.cpp.

802void ManGenerator::startConstraintType()

803{

804 startEmphasis();

805}

Reference startEmphasis.

startContents()

void ManGenerator::startContents ()

inline virtual

Definition at line 215 of file mangen.h.

215 void startContents() override {}

startDescForItem()

void ManGenerator::startDescForItem ()

virtual

Declaration at line 195 of file mangen.h, definition at line 592 of file mangen.cpp.

592void ManGenerator::startDescForItem()

593{

594 if (!m_firstCol) m_t << "\n";

595 if (!m_paragraph) m_t << ".in -1c\n";

596 m_t << ".in +1c\n";

597 m_firstCol=TRUE;

598 m_paragraph=FALSE;

599 m_col=0;

600}

References FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t and TRUE.

Referenced by startDescTable.

startDescTable()

void ManGenerator::startDescTable (const QCString & title, const bool hasInits)

virtual

Declaration at line 219 of file mangen.h, definition at line 743 of file mangen.cpp.

743void ManGenerator::startDescTable(const QCString &title,const bool hasInits)

744{

745 if (!m_firstCol)

746 { m_t << "\n.PP\n";

747 m_firstCol=TRUE; m_paragraph=TRUE;

748 m_col=0;

749 }

750 m_paragraph=FALSE;

751 startBold();

752 docify(title);

753 endBold();

754 m_paragraph=TRUE;

755 startDescForItem();

756}

References docify, endBold, FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, startBold, startDescForItem and TRUE.

startDescTableData()

void ManGenerator::startDescTableData ()

inline virtual

Definition at line 227 of file mangen.h.

227 void startDescTableData() override { m_t << "\n"; m_firstCol=TRUE; }

References m_firstCol, OutputGenerator::m_t and TRUE.

startDescTableInit()

void ManGenerator::startDescTableInit ()

inline virtual

Definition at line 225 of file mangen.h.

225 void startDescTableInit() override {};

startDescTableRow()

void ManGenerator::startDescTableRow ()

inline virtual

Definition at line 223 of file mangen.h.

223 void startDescTableRow() override {}

startDescTableTitle()

void ManGenerator::startDescTableTitle ()

inline virtual

Definition at line 221 of file mangen.h.

221 void startDescTableTitle() override { startItemListItem(); startBoldEmphasis(); endItemListItem(); }

References endItemListItem, startBoldEmphasis and startItemListItem.

startDirDepGraph()

void ManGenerator::startDirDepGraph ()

inline virtual

Definition at line 238 of file mangen.h.

238 void startDirDepGraph() override {}

startDotGraph()

void ManGenerator::startDotGraph ()

inline virtual

Definition at line 230 of file mangen.h.

230 void startDotGraph() override {}

startDoxyAnchor()

void ManGenerator::startDoxyAnchor (const QCString &, const QCString & manName, const QCString &, const QCString & name, const QCString &)

virtual

Declaration at line 176 of file mangen.h, definition at line 531 of file mangen.cpp.

531void ManGenerator::startDoxyAnchor(const QCString &,const QCString &manName,

532 const QCString &, const QCString &name,

533 const QCString &)

534{

535 // something to be done?

536 if( !Config_getBool(MAN_LINKS) )

537 {

538 return; // no

539 }

540

541 // the name of the link file is derived from the name of the anchor:

542 // - truncate after an (optional) ::

543 QCString baseName = name;

544 int i=baseName.findRev("::");

545 if (i!=-1) baseName=baseName.right(baseName.length()-i-2);

546

547 //printf("Converting man link '%s'->'%s'->'%s'\n",

548 // name,qPrint(baseName),qPrint(buildFileName(baseName)));

549

550 // - remove dangerous characters and append suffix, then add dir prefix

551 QCString fileName=dir()+"/"+buildFileName( baseName );

552 FileInfo fi(fileName.str());

553 if (!fi.exists())

554 {

555 std::ofstream linkStream = Portable::openOutputStream(fileName);

556 if (linkStream.is_open())

557 {

558 linkStream << ".so " << getSubdir() << "/" << buildFileName( manName ) << "\n";

559 }

560 }

561}

References buildFileName, Config_getBool, OutputGenerator::dir, FileInfo::exists, OutputGenerator::fileName, QCString::findRev, getSubdir, QCString::length, Portable::openOutputStream and QCString::right.

startEmphasis()

void ManGenerator::startEmphasis ()

inline virtual

Definition at line 166 of file mangen.h.

166 void startEmphasis() override { m_t << "\\fI"; m_firstCol=FALSE; }

References FALSE, m_firstCol and OutputGenerator::m_t.

Referenced by startConstraintParam and startConstraintType.

startExamples()

void ManGenerator::startExamples ()

virtual

Declaration at line 193 of file mangen.h, definition at line 725 of file mangen.cpp.

725void ManGenerator::startExamples()

726{

727 if (!m_firstCol)

728 { m_t << "\n" << ".PP\n";

729 m_firstCol=TRUE; m_paragraph=TRUE;

730 m_col=0;

731 }

732 m_paragraph=FALSE;

733 startBold();

734 docify(theTranslator->trExamples());

735 endBold();

736 m_paragraph=TRUE;

737}

References docify, endBold, FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, startBold, theTranslator and TRUE.

startFile()

void ManGenerator::startFile (const QCString & name, const QCString & manName, const QCString & title, int id, int hierarchyLevel)

virtual

Declaration at line 89 of file mangen.h, definition at line 337 of file mangen.cpp.

337void ManGenerator::startFile(const QCString &,const QCString &manName,const QCString &,int,int)

338{

339 startPlainFile( buildFileName( manName ) );

340 m_firstCol=TRUE;

341}

References buildFileName, m_firstCol, startPlainFile and TRUE.

startGroupCollaboration()

void ManGenerator::startGroupCollaboration ()

inline virtual

Definition at line 234 of file mangen.h.

234 void startGroupCollaboration() override {}

startGroupHeader()

void ManGenerator::startGroupHeader (const QCString &, int)

virtual

Declaration at line 128 of file mangen.h, definition at line 430 of file mangen.cpp.

430void ManGenerator::startGroupHeader(const QCString &,int)

431{

432 if (!m_firstCol) m_t << "\n";

433 m_t << ".SH \"";

434 m_upperCase=TRUE;

435 m_firstCol=FALSE;

436}

References FALSE, m_firstCol, OutputGenerator::m_t, m_upperCase and TRUE.

Referenced by startSection.

startHeaderSection()

void ManGenerator::startHeaderSection ()

inline virtual

Definition at line 132 of file mangen.h.

132 void startHeaderSection() override {}

startInclDepGraph()

void ManGenerator::startInclDepGraph ()

inline virtual

Definition at line 232 of file mangen.h.

232 void startInclDepGraph() override {}

startIndent()

void ManGenerator::startIndent ()

inline virtual

Definition at line 200 of file mangen.h.

200 void startIndent() override {}

startIndexItem()

void ManGenerator::startIndexItem (const QCString & ref, const QCString & file)

virtual

Declaration at line 119 of file mangen.h, definition at line 411 of file mangen.cpp.

411void ManGenerator::startIndexItem(const QCString &,const QCString &)

412{

413}

startIndexKey()

void ManGenerator::startIndexKey ()

inline virtual

Definition at line 113 of file mangen.h.

113 void startIndexKey() override {}

startIndexList()

void ManGenerator::startIndexList ()

inline virtual

Definition at line 111 of file mangen.h.

111 void startIndexList() override {}

startIndexListItem()

void ManGenerator::startIndexListItem ()

inline virtual

Definition at line 109 of file mangen.h.

109 void startIndexListItem() override {}

startIndexSection()

void ManGenerator::startIndexSection (IndexSection)

inline virtual

Definition at line 97 of file mangen.h.

97 void startIndexSection(IndexSection) override {}

startIndexValue()

void ManGenerator::startIndexValue (bool)

inline virtual

Definition at line 115 of file mangen.h.

115 void startIndexValue(bool) override {}

startInlineHeader()

void ManGenerator::startInlineHeader ()

virtual

Declaration at line 146 of file mangen.h, definition at line 826 of file mangen.cpp.

826void ManGenerator::startInlineHeader()

827{

828 if (!m_firstCol)

829 {

830 m_t << "\n.PP\n" << ".in -1c\n";

831 }

832 m_t << ".RI \"\\fB";

833}

References m_firstCol and OutputGenerator::m_t.

startInlineMemberDoc()

void ManGenerator::startInlineMemberDoc ()

virtual

Declaration at line 277 of file mangen.h, definition at line 887 of file mangen.cpp.

887void ManGenerator::startInlineMemberDoc()

888{

889}

startInlineMemberName()

void ManGenerator::startInlineMemberName ()

virtual

Declaration at line 275 of file mangen.h, definition at line 877 of file mangen.cpp.

877void ManGenerator::startInlineMemberName()

878{

879 m_t << "\\fI";

880}

Reference OutputGenerator::m_t.

startInlineMemberType()

void ManGenerator::startInlineMemberType ()

virtual

Declaration at line 273 of file mangen.h, definition at line 868 of file mangen.cpp.

868void ManGenerator::startInlineMemberType()

869{

870}

startItemList()

void ManGenerator::startItemList ()

inline virtual

Definition at line 117 of file mangen.h.

117 void startItemList() override {}

startItemListItem()

void ManGenerator::startItemListItem ()

virtual

Declaration at line 140 of file mangen.h, definition at line 510 of file mangen.cpp.

510void ManGenerator::startItemListItem()

511{

512 if (!m_firstCol) m_t << "\n";

513 m_t << ".TP\n";

514 m_firstCol=TRUE;

515 m_paragraph=FALSE;

516 m_col=0;

517}

References FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t and TRUE.

Referenced by startConstraintParam and startDescTableTitle.

startLabels()

void ManGenerator::startLabels ()

virtual

Declaration at line 280 of file mangen.h, definition at line 899 of file mangen.cpp.

899void ManGenerator::startLabels()

900{

901}

startLocalToc()

void ManGenerator::startLocalToc (int)

inline virtual

Definition at line 284 of file mangen.h.

284 void startLocalToc(int) override {}

startMemberDeclaration()

void ManGenerator::startMemberDeclaration ()

inline virtual

Definition at line 189 of file mangen.h.

189 void startMemberDeclaration() override {}

startMemberDescription()

void ManGenerator::startMemberDescription (const QCString &, const QCString &, bool)

inline virtual

Definition at line 187 of file mangen.h.

187 void startMemberDescription(const QCString &,const QCString &,bool) override { m_t << "\n.RI \""; m_firstCol=FALSE; }

References FALSE, m_firstCol and OutputGenerator::m_t.

startMemberDoc()

void ManGenerator::startMemberDoc (const QCString &, const QCString &, const QCString &, const QCString &, int, int, bool)

virtual

Declaration at line 174 of file mangen.h, definition at line 523 of file mangen.cpp.

523void ManGenerator::startMemberDoc(const QCString &,const QCString &,const QCString &,const QCString &,int,int,bool)

524{

525 if (!m_firstCol) m_t << "\n";

526 m_t << ".SS \"";

527 m_firstCol=FALSE;

528 m_paragraph=FALSE;

529}

References FALSE, m_firstCol, m_paragraph and OutputGenerator::m_t.

startMemberDocList()

void ManGenerator::startMemberDocList ()

inline virtual

Definition at line 142 of file mangen.h.

142 void startMemberDocList() override {}

startMemberDocName()

void ManGenerator::startMemberDocName (bool)

inline virtual

Definition at line 248 of file mangen.h.

248 void startMemberDocName(bool) override {}

startMemberDocPrefixItem()

void ManGenerator::startMemberDocPrefixItem ()

inline virtual

Definition at line 246 of file mangen.h.

246 void startMemberDocPrefixItem() override {}

startMemberDocSimple()

void ManGenerator::startMemberDocSimple (bool isEnum)

virtual

Declaration at line 271 of file mangen.h, definition at line 841 of file mangen.cpp.

841void ManGenerator::startMemberDocSimple(bool isEnum)

842{

843 if (!m_firstCol)

844 {

845 m_t << "\n.PP\n";

846 }

847 m_t << "\\fB";

848 if (isEnum)

849 {

850 docify(theTranslator->trEnumerationValues());

851 }

852 else

853 {

854 docify(theTranslator->trCompoundMembers());

855 }

856 m_t << ":\\fP\n";

857 m_t << ".RS 4\n";

858}

References docify, m_firstCol, OutputGenerator::m_t and theTranslator.

startMemberGroup()

void ManGenerator::startMemberGroup ()

virtual

Declaration at line 161 of file mangen.h, definition at line 671 of file mangen.cpp.

671void ManGenerator::startMemberGroup()

672{

673 m_t << "\n.in +1c";

674}

Reference OutputGenerator::m_t.

startMemberGroupDocs()

void ManGenerator::startMemberGroupDocs ()

virtual

Declaration at line 159 of file mangen.h, definition at line 662 of file mangen.cpp.

662void ManGenerator::startMemberGroupDocs()

663{

664}

startMemberGroupHeader()

void ManGenerator::startMemberGroupHeader (const QCString &, bool)

virtual

Declaration at line 157 of file mangen.h, definition at line 651 of file mangen.cpp.

651void ManGenerator::startMemberGroupHeader(const QCString &,bool)

652{

653 m_t << "\n.PP\n.RI \"\\fB";

654}

Reference OutputGenerator::m_t.

startMemberHeader()

void ManGenerator::startMemberHeader (const QCString &, int)

virtual

Declaration at line 134 of file mangen.h, definition at line 446 of file mangen.cpp.

446void ManGenerator::startMemberHeader(const QCString &,int)

447{

448 if (!m_firstCol) m_t << "\n";

449 m_t << ".SS \"";

450}

References m_firstCol and OutputGenerator::m_t.

Referenced by startSection.

startMemberItem()

void ManGenerator::startMemberItem (const QCString &, MemberItemType, const QCString &)

virtual

Declaration at line 150 of file mangen.h, definition at line 623 of file mangen.cpp.

623void ManGenerator::startMemberItem(const QCString &,MemberItemType,const QCString &)

624{

625 if (m_firstCol && !m_insideTabbing) m_t << ".in +1c\n";

626 m_t << "\n.ti -1c\n.RI \"";

627 m_firstCol=FALSE;

628}

References FALSE, m_firstCol, m_insideTabbing and OutputGenerator::m_t.

startMemberList()

void ManGenerator::startMemberList ()

virtual

Declaration at line 144 of file mangen.h, definition at line 635 of file mangen.cpp.

635void ManGenerator::startMemberList()

636{

637 if (!m_insideTabbing)

638 {

639 m_t << "\n.in +1c"; m_firstCol=FALSE;

640 }

641}

References FALSE, m_firstCol, m_insideTabbing and OutputGenerator::m_t.

startMemberSections()

void ManGenerator::startMemberSections ()

inline virtual

Definition at line 130 of file mangen.h.

130 void startMemberSections() override {}

startMemberSubtitle()

void ManGenerator::startMemberSubtitle ()

inline virtual

Definition at line 138 of file mangen.h.

138 void startMemberSubtitle() override {}

startMemberTemplateParams()

void ManGenerator::startMemberTemplateParams ()

inline virtual

Definition at line 152 of file mangen.h.

152 void startMemberTemplateParams() override {}

startPageDoc()

void ManGenerator::startPageDoc (const QCString &)

inline virtual

Definition at line 95 of file mangen.h.

95 void startPageDoc(const QCString &) override {}

startPageRef()

void ManGenerator::startPageRef ()

inline virtual

Definition at line 205 of file mangen.h.

205 void startPageRef() override {}

startParagraph()

void ManGenerator::startParagraph (const QCString & classDef)

virtual

Declaration at line 106 of file mangen.h, definition at line 391 of file mangen.cpp.

391void ManGenerator::startParagraph(const QCString &)

392{

393 if (!m_paragraph)

394 {

395 if (!m_firstCol) m_t << "\n";

396 m_t << ".PP\n";

397 m_firstCol=TRUE;

398 }

399 m_paragraph=TRUE;

400}

References m_firstCol, m_paragraph, OutputGenerator::m_t and TRUE.

startParameterDefVal()

void ManGenerator::startParameterDefVal (const char * s)

inline virtual

Definition at line 256 of file mangen.h.

256 void startParameterDefVal(const char *s) override { docify(s); startTypewriter(); }

References docify and startTypewriter.

startParameterExtra()

void ManGenerator::startParameterExtra ()

inline virtual

Definition at line 254 of file mangen.h.

254 void startParameterExtra() override {}

startParameterList()

void ManGenerator::startParameterList (bool openBracket)

virtual

Declaration at line 258 of file mangen.h, definition at line 927 of file mangen.cpp.

927void ManGenerator::startParameterList(bool openBracket)

928{

929 if (openBracket) m_t << "(";

930}

Reference OutputGenerator::m_t.

startParameterName()

void ManGenerator::startParameterName (bool)

inline virtual

Definition at line 252 of file mangen.h.

252 void startParameterName(bool) override {}

startParameterType()

void ManGenerator::startParameterType (bool, const QCString &)

inline virtual

Definition at line 250 of file mangen.h.

250 void startParameterType(bool,const QCString &) override {}

startPlainFile()

void ManGenerator::startPlainFile (const QCString & name)

inline virtual

Definition at line 289 of file mangen.h.

289 void startPlainFile(const QCString &name) override { OutputGenerator::startPlainFile(name); }

Reference OutputGenerator::startPlainFile.

Referenced by startFile.

startProjectNumber()

void ManGenerator::startProjectNumber ()

inline virtual

Definition at line 100 of file mangen.h.

100 void startProjectNumber() override {}

startQuickIndices()

void ManGenerator::startQuickIndices ()

inline virtual

Definition at line 207 of file mangen.h.

207 void startQuickIndices() override {}

startSection()

void ManGenerator::startSection (const QCString &, const QCString &, SectionType type)

virtual

Declaration at line 197 of file mangen.h, definition at line 682 of file mangen.cpp.

682void ManGenerator::startSection(const QCString &,const QCString &,SectionType type)

683{

684 if( !m_inHeader )

685 {

686 switch(type.level())

687 {

688 case SectionType::Page: // fall through

689 case SectionType::Section: startGroupHeader("",0); break;

690 case SectionType::Subsection: // fall through

691 case SectionType::Subsubsection: // fall through

692 case SectionType::Paragraph: // fall through

693 case SectionType::Subparagraph: // fall through

694 case SectionType::Subsubparagraph: startMemberHeader(QCString(), -1); break;

695 default: ASSERT(0); break;

696 }

697 }

698}

References ASSERT, m_inHeader, SectionType::Page, SectionType::Paragraph, SectionType::Section, startGroupHeader, startMemberHeader, SectionType::Subparagraph, SectionType::Subsection, SectionType::Subsubparagraph, SectionType::Subsubsection and type.

startSmall()

void ManGenerator::startSmall ()

inline virtual

Definition at line 185 of file mangen.h.

185 void startSmall() override {}

startTextBlock()

void ManGenerator::startTextBlock (bool)

inline virtual

Definition at line 242 of file mangen.h.

242 void startTextBlock(bool) override {}

startTextLink()

void ManGenerator::startTextLink (const QCString &, const QCString &)

inline virtual

Definition at line 124 of file mangen.h.

124 void startTextLink(const QCString &,const QCString &) override {}

startTitleHead()

void ManGenerator::startTitleHead (const QCString &)

inline virtual

Definition at line 103 of file mangen.h.

103 void startTitleHead(const QCString &) override {}

startTocEntry()

void ManGenerator::startTocEntry (const SectionInfo *)

inline virtual

Definition at line 286 of file mangen.h.

286 void startTocEntry(const SectionInfo *) override {}

startTypewriter()

void ManGenerator::startTypewriter ()

inline virtual

Definition at line 126 of file mangen.h.

126 void startTypewriter() override { m_t << "\\fR"; m_firstCol=FALSE; }

References FALSE, m_firstCol and OutputGenerator::m_t.

Referenced by startParameterDefVal.

type()

OutputType ManGenerator::type ()

inline virtual

Definition at line 84 of file mangen.h.

84 OutputType type() const override { return OutputType::Man; }

Reference Man.

Referenced by endSection and startSection.

writeAnchor()

void ManGenerator::writeAnchor (const QCString &, const QCString &)

inline virtual

Definition at line 165 of file mangen.h.

165 void writeAnchor(const QCString &,const QCString &) override {}

writeChar()

void ManGenerator::writeChar (char c)

virtual

Declaration at line 173 of file mangen.h, definition at line 483 of file mangen.cpp.

483void ManGenerator::writeChar(char c)

484{

485 m_firstCol=(c=='\n');

486 if (m_firstCol) m_col=0; else m_col++;

487 switch (c)

488 {

489 case '\\': m_t << "\\\\"; break;

490 case '\"': c = '\''; // no break!

491 default: m_t << c; break;

492 }

493 //printf("%c",c);fflush(stdout);

494 m_paragraph=FALSE;

495}

References FALSE, m_col, m_firstCol, m_paragraph and OutputGenerator::m_t.

writeDoc()

void ManGenerator::writeDoc (const IDocNodeAST * ast, const Definition * ctx, const MemberDef *, int)

virtual

Declaration at line 88 of file mangen.h, definition at line 763 of file mangen.cpp.

763void ManGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *,int)

764{

765 const DocNodeAST *astImpl = dynamic_cast<const DocNodeAST *>(ast);

766 if (astImpl)

767 {

768 ManDocVisitor visitor(m_t,*m_codeList,ctx?ctx->getDefFileExtension():QCString(""));

769 std::visit(visitor,astImpl->root);

770 }

771 m_firstCol=FALSE;

772 m_paragraph = FALSE;

773}

References FALSE, Definition::getDefFileExtension, m_codeList, m_firstCol, m_paragraph, OutputGenerator::m_t and DocNodeAST::root.

writeFooter()

void ManGenerator::writeFooter (const QCString &)

inline virtual

Definition at line 93 of file mangen.h.

93 void writeFooter(const QCString &) override {}

writeGraphicalHierarchy()

void ManGenerator::writeGraphicalHierarchy (DotGfxHierarchyTable &)

inline virtual

Definition at line 240 of file mangen.h.

240 void writeGraphicalHierarchy(DotGfxHierarchyTable &) override {}

writeInheritedSectionTitle()

void ManGenerator::writeInheritedSectionTitle (const QCString &, const QCString &, const QCString &, const QCString &, const QCString & title, const QCString & name)

virtual

Declaration at line 191 of file mangen.h, definition at line 917 of file mangen.cpp.

917void ManGenerator::writeInheritedSectionTitle(

918 const QCString &/*id*/, const QCString &/*ref*/,

919 const QCString &/*file*/, const QCString &/*anchor*/,

920 const QCString &title, const QCString &name)

921{

922 m_t << "\n\n";

923 m_t << theTranslator->trInheritedFrom(docifyToString(title), objectLinkToString(name));

924 m_firstCol = FALSE;

925}

References docifyToString, FALSE, m_firstCol, OutputGenerator::m_t, objectLinkToString and theTranslator.

writeLabel()

void ManGenerator::writeLabel (const QCString & l, bool isLast)

virtual

Declaration at line 281 of file mangen.h, definition at line 903 of file mangen.cpp.

903void ManGenerator::writeLabel(const QCString &l,bool isLast)

904{

905 m_t << "\\fR [" << l << "]\\fP";

906 if (!isLast) m_t << ", ";

907}

Reference OutputGenerator::m_t.

writeLatexSpacing()

void ManGenerator::writeLatexSpacing ()

inline virtual

Definition at line 179 of file mangen.h.

179 void writeLatexSpacing() override {}

writeLogo()

void ManGenerator::writeLogo ()

inline virtual

Definition at line 211 of file mangen.h.

211 void writeLogo() override {}

writeNavigationPath()

void ManGenerator::writeNavigationPath (const QCString &)

inline virtual

Definition at line 210 of file mangen.h.

210 void writeNavigationPath(const QCString &) override {}

writeNonBreakableSpace()

void ManGenerator::writeNonBreakableSpace (int n)

inline virtual

Definition at line 217 of file mangen.h.

217 void writeNonBreakableSpace(int n) override { for (int i=0;i<n;i++) m_t << " "; }

Reference OutputGenerator::m_t.

writeObjectLink()

void ManGenerator::writeObjectLink (const QCString & ref, const QCString & file, const QCString & anchor, const QCString & name)

virtual

Declaration at line 122 of file mangen.h, definition at line 424 of file mangen.cpp.

424void ManGenerator::writeObjectLink(const QCString &,const QCString &,

425 const QCString &, const QCString &name)

426{

427 startBold(); docify(name); endBold();

428}

References docify, endBold and startBold.

writePageLink()

void ManGenerator::writePageLink (const QCString &, bool)

inline virtual

Definition at line 99 of file mangen.h.

99 void writePageLink(const QCString &,bool) override {}

writePageOutline()

void ManGenerator::writePageOutline ()

inline virtual

Definition at line 214 of file mangen.h.

214 void writePageOutline() override {}

writeQuickLinks()

void ManGenerator::writeQuickLinks (HighlightedItem, const QCString &, bool)

inline virtual

Definition at line 212 of file mangen.h.

212 void writeQuickLinks(HighlightedItem,const QCString &,bool) override {}

writeRuler()

void ManGenerator::writeRuler ()

inline virtual

Definition at line 164 of file mangen.h.

164 void writeRuler() override {}

writeSearchInfo()

void ManGenerator::writeSearchInfo ()

inline virtual

Definition at line 92 of file mangen.h.

92 void writeSearchInfo() override {}

writeSplitBar()

void ManGenerator::writeSplitBar (const QCString &, const QCString &)

inline virtual

Definition at line 209 of file mangen.h.

209 void writeSplitBar(const QCString &,const QCString &) override {}

writeStartAnnoItem()

void ManGenerator::writeStartAnnoItem (const QCString & type, const QCString & file, const QCString & path, const QCString & name)

virtual

Declaration at line 181 of file mangen.h, definition at line 419 of file mangen.cpp.

419void ManGenerator::writeStartAnnoItem(const QCString &,const QCString &,

420 const QCString &,const QCString &)

421{

422}

writeString()

void ManGenerator::writeString (const QCString & text)

virtual

Declaration at line 108 of file mangen.h, definition at line 406 of file mangen.cpp.

406void ManGenerator::writeString(const QCString &text)

407{

408 docify(text);

409}

Reference docify.

writeStyleInfo()

void ManGenerator::writeStyleInfo (int)

inline virtual

Definition at line 102 of file mangen.h.

102 void writeStyleInfo(int) override {}

writeSummaryLink()

void ManGenerator::writeSummaryLink (const QCString &, const QCString &, const QCString &, bool)

inline virtual

Definition at line 213 of file mangen.h.

213 void writeSummaryLink(const QCString &,const QCString &,const QCString &,bool) override {}

writeSynopsis()

void ManGenerator::writeSynopsis ()

virtual

Declaration at line 202 of file mangen.h, definition at line 584 of file mangen.cpp.

584void ManGenerator::writeSynopsis()

585{

586 if (!m_firstCol) m_t << "\n";

587 m_t << ".SH SYNOPSIS\n.br\n.PP\n";

588 m_firstCol=TRUE;

589 m_paragraph=FALSE;

590}

References FALSE, m_firstCol, m_paragraph, OutputGenerator::m_t and TRUE.

Private Member Functions

endTitle()

void ManGenerator::endTitle ()

Declaration at line 294 of file mangen.h, definition at line 505 of file mangen.cpp.

505void ManGenerator::endTitle()

506{

507 m_t << "\"";

508}

Reference OutputGenerator::m_t.

startTitle()

void ManGenerator::startTitle ()

Declaration at line 293 of file mangen.h, definition at line 497 of file mangen.cpp.

497void ManGenerator::startTitle()

498{

499 if (!m_firstCol) m_t << "\n";

500 m_t << ".SH \"";

501 m_firstCol=FALSE;

502 m_paragraph=FALSE;

503}

References FALSE, m_firstCol, m_paragraph and OutputGenerator::m_t.

Private Member Attributes

m_codeGen

ManCodeGenerator* ManGenerator::m_codeGen

Definition at line 303 of file mangen.h.

303 ManCodeGenerator *m_codeGen;

Referenced by addCodeGen, ManGenerator, ManGenerator and operator=.

m_codeList

std::unique_ptr<OutputCodeList> ManGenerator::m_codeList

Definition at line 302 of file mangen.h.

302 std::unique_ptr<OutputCodeList> m_codeList;

Referenced by ManGenerator, ManGenerator, operator= and writeDoc.

m_col

int ManGenerator::m_col = 0

Definition at line 297 of file mangen.h.

297 int m_col = 0;

Referenced by docify, ManGenerator, operator=, startConstraintList, startDescForItem, startDescTable, startExamples, startItemListItem and writeChar.

m_firstCol

bool ManGenerator::m_firstCol = true

Definition at line 296 of file mangen.h.

296 bool m_firstCol = true;

Referenced by docify, endBold, endBoldEmphasis, endConstraintDocs, endEmphasis, endGroupHeader, endInlineHeader, endInlineMemberDoc, endMemberDescription, endMemberDocSimple, endMemberGroup, endMemberGroupHeader, endMemberHeader, endMemberList, endSection, endTitleHead, endTypewriter, ManGenerator, newParagraph, operator=, startBold, startBoldEmphasis, startCompoundTemplateParams, startConstraintList, startDescForItem, startDescTable, startDescTableData, startEmphasis, startExamples, startFile, startGroupHeader, startInlineHeader, startItemListItem, startMemberDescription, startMemberDoc, startMemberDocSimple, startMemberHeader, startMemberItem, startMemberList, startParagraph, startTitle, startTypewriter, writeChar, writeDoc, writeInheritedSectionTitle and writeSynopsis.

m_inHeader

bool ManGenerator::m_inHeader = false

Definition at line 301 of file mangen.h.

301 bool m_inHeader = false;

Referenced by endSection, endTitleHead, ManGenerator, operator= and startSection.

m_insideTabbing

bool ManGenerator::m_insideTabbing = false

Definition at line 300 of file mangen.h.

300 bool m_insideTabbing = false;

Referenced by endAnonTypeScope, endMemberList, ManGenerator, operator=, startAnonTypeScope, startMemberItem and startMemberList.

m_paragraph

bool ManGenerator::m_paragraph = true

Definition at line 298 of file mangen.h.

298 bool m_paragraph = true;

Referenced by docify, endGroupHeader, endMemberHeader, endSection, endTitleHead, ManGenerator, newParagraph, operator=, startCompoundTemplateParams, startConstraintList, startDescForItem, startDescTable, startExamples, startItemListItem, startMemberDoc, startParagraph, startTitle, writeChar, writeDoc and writeSynopsis.

m_upperCase

bool ManGenerator::m_upperCase = false

Definition at line 299 of file mangen.h.

299 bool m_upperCase = false;

Referenced by endGroupHeader, ManGenerator, operator= and startGroupHeader.

Public Static Functions

init()

void ManGenerator::init ()

static

Declaration at line 78 of file mangen.h, definition at line 272 of file mangen.cpp.

272void ManGenerator::init()

273{

274 QCString manOutput = Config_getString(MAN_OUTPUT);

275

276 Dir d(manOutput.str());

277 if (!d.exists() && !d.mkdir(manOutput.str()))

278 {

279 term("Could not create output directory {}\n",manOutput);

280 }

281 std::string manDir = manOutput.str()+"/"+getSubdir().str();

282 if (!d.exists(manDir) && !d.mkdir(manDir))

283 {

284 term("Could not create output directory {}/{}\n",manOutput,getSubdir());

285 }

286 createSubDirs(d);

287}

References Config_getString, createSubDirs, Dir::exists, getSubdir, Dir::mkdir, QCString::str and term.

Referenced by generateOutput.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.

Declaration​

Included Headers​

Base classes​

Public Constructors Index​

Public Destructor Index​

Public Operators Index​

Public Member Functions Index​

Private Member Functions Index​

Private Member Attributes Index​

Public Static Functions Index​

Description​

Public Constructors​

ManGenerator()​

ManGenerator()​

ManGenerator()​

Public Destructor​

~ManGenerator()​

Public Operators​

operator=()​

operator=()​

Public Member Functions​

addCodeGen()​

addIndexItem()​

addLabel()​

cleanup()​

clearBuffer()​

clone()​

docify()​

endAnonTypeScope()​

endBold()​

endBoldEmphasis()​

endCallGraph()​

endCenter()​

endClassDiagram()​

endCompoundTemplateParams()​

endConstraintDocs()​

endConstraintList()​

endConstraintParam()​

endConstraintType()​

endContents()​

endDescForItem()​

endDescTable()​

endDescTableData()​

endDescTableInit()​

endDescTableRow()​

endDescTableTitle()​

endDirDepGraph()​

endDotGraph()​

endDoxyAnchor()​

endEmphasis()​

endExamples()​

endFile()​

endGroupCollaboration()​

endGroupHeader()​

endHeaderSection()​

endInclDepGraph()​

endIndent()​

endIndexItem()​

endIndexKey()​

endIndexList()​

endIndexListItem()​

endIndexSection()​

endIndexValue()​

endInlineHeader()​

endInlineMemberDoc()​

endInlineMemberName()​

endInlineMemberType()​

endItemList()​

endItemListItem()​

endLabels()​

endLocalToc()​

endMemberDeclaration()​

endMemberDescription()​

endMemberDoc()​

endMemberDocList()​

endMemberDocName()​

endMemberDocPrefixItem()​

endMemberDocSimple()​

endMemberGroup()​

endMemberGroupDocs()​

Declaration

Included Headers

Base classes

Public Constructors Index

Public Destructor Index

Public Operators Index

Public Member Functions Index

Private Member Functions Index

Private Member Attributes Index

Public Static Functions Index

Description

Public Constructors

ManGenerator()

ManGenerator()

ManGenerator()

Public Destructor

~ManGenerator()

Public Operators

operator=()

operator=()

Public Member Functions

addCodeGen()

addIndexItem()

addLabel()

cleanup()

clearBuffer()

clone()

docify()

endAnonTypeScope()

endBold()

endBoldEmphasis()

endCallGraph()

endCenter()

endClassDiagram()

endCompoundTemplateParams()

endConstraintDocs()

endConstraintList()

endConstraintParam()

endConstraintType()

endContents()

endDescForItem()

endDescTable()

endDescTableData()

endDescTableInit()

endDescTableRow()

endDescTableTitle()

endDirDepGraph()

endDotGraph()

endDoxyAnchor()

endEmphasis()

endExamples()

endFile()

endGroupCollaboration()

endGroupHeader()

endHeaderSection()

endInclDepGraph()

endIndent()

endIndexItem()

endIndexKey()

endIndexList()

endIndexListItem()

endIndexSection()

endIndexValue()

endInlineHeader()

endInlineMemberDoc()

endInlineMemberName()

endInlineMemberType()

endItemList()

endItemListItem()

endLabels()

endLocalToc()

endMemberDeclaration()

endMemberDescription()

endMemberDoc()

endMemberDocList()

endMemberDocName()

endMemberDocPrefixItem()

endMemberDocSimple()

endMemberGroup()

endMemberGroupDocs()