doxygen  1.8.18
About: Doxygen is a source code documentation generator tool for C++, C, Objective-C, C#, PHP, Java, Python, IDL (diverse flavors), Fortran, VHDL, Tcl, and to some extent D. Different output formats are supported.
  Fossies Dox: doxygen-1.8.18.src.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

ManGenerator Class Reference

Generator for Man page output. More...

#include <mangen.h>

+ Inheritance diagram for ManGenerator:
+ Collaboration diagram for ManGenerator:

Public Member Functions

 ManGenerator ()
 
 ~ManGenerator ()
 
void enable ()
 
void disable ()
 
void enableIf (OutputType o)
 
void disableIf (OutputType o)
 
void disableIfNot (OutputType o)
 
bool isEnabled (OutputType o)
 
OutputGeneratorget (OutputType o)
 
void writeDoc (DocNode *, const Definition *, const MemberDef *)
 
void startFile (const char *name, const char *manName, const char *title)
 
void writeSearchInfo ()
 
void writeFooter (const char *)
 
void endFile ()
 
void clearBuffer ()
 
void startIndexSection (IndexSections)
 
void endIndexSection (IndexSections)
 
void writePageLink (const char *, bool)
 
void startProjectNumber ()
 
void endProjectNumber ()
 
void writeStyleInfo (int)
 
void startTitleHead (const char *)
 
void endTitleHead (const char *, const char *)
 
void startTitle ()
 
void endTitle ()
 
void newParagraph ()
 
void startParagraph (const char *classDef)
 
void endParagraph ()
 
void writeString (const char *text)
 
void startIndexListItem ()
 
void endIndexListItem ()
 
void startIndexList ()
 
void endIndexList ()
 
void startIndexKey ()
 
void endIndexKey ()
 
void startIndexValue (bool)
 
void endIndexValue (const char *, bool)
 
void startItemList ()
 
void endItemList ()
 
void startIndexItem (const char *ref, const char *file)
 
void endIndexItem (const char *ref, const char *file)
 
void docify (const char *text)
 
void codify (const char *text)
 
void writeObjectLink (const char *ref, const char *file, const char *anchor, const char *name)
 
void writeCodeLink (const char *ref, const char *file, const char *anchor, const char *name, const char *tooltip)
 
void writeTooltip (const char *, const DocLinkInfo &, const char *, const char *, const SourceLinkInfo &, const SourceLinkInfo &)
 
void startTextLink (const char *, const char *)
 
void endTextLink ()
 
void startHtmlLink (const char *url)
 
void endHtmlLink ()
 
void startTypewriter ()
 
void endTypewriter ()
 
void startGroupHeader (int)
 
void endGroupHeader (int)
 
void startMemberSections ()
 
void endMemberSections ()
 
void startHeaderSection ()
 
void endHeaderSection ()
 
void startMemberHeader (const char *, int)
 
void endMemberHeader ()
 
void insertMemberAlign (bool)
 
void insertMemberAlignLeft (int, bool)
 
void startMemberSubtitle ()
 
void endMemberSubtitle ()
 
void startItemListItem ()
 
void endItemListItem ()
 
void startMemberDocList ()
 
void endMemberDocList ()
 
void startMemberList ()
 
void endMemberList ()
 
void startInlineHeader ()
 
void endInlineHeader ()
 
void startAnonTypeScope (int)
 
void endAnonTypeScope (int)
 
void startMemberItem (const char *, int, const char *)
 
void endMemberItem ()
 
void startMemberTemplateParams ()
 
void endMemberTemplateParams (const char *, const char *)
 
void startMemberGroupHeader (bool)
 
void endMemberGroupHeader ()
 
void startMemberGroupDocs ()
 
void endMemberGroupDocs ()
 
void startMemberGroup ()
 
void endMemberGroup (bool)
 
void writeRuler ()
 
void writeAnchor (const char *, const char *)
 
void startCodeFragment ()
 
void endCodeFragment ()
 
void writeLineNumber (const char *, const char *, const char *, int l)
 
void startCodeLine (bool)
 
void endCodeLine ()
 
void startEmphasis ()
 
void endEmphasis ()
 
void startBold ()
 
void endBold ()
 
void startDescription ()
 
void endDescription ()
 
void startDescItem ()
 
void endDescItem ()
 
void lineBreak (const char *)
 
void writeChar (char c)
 
void startMemberDoc (const char *, const char *, const char *, const char *, int, int, bool)
 
void endMemberDoc (bool)
 
void startDoxyAnchor (const char *, const char *, const char *, const char *, const char *)
 
void endDoxyAnchor (const char *, const char *)
 
void writeLatexSpacing ()
 
void writeStartAnnoItem (const char *type, const char *file, const char *path, const char *name)
 
void writeEndAnnoItem (const char *)
 
void startSubsection ()
 
void endSubsection ()
 
void startSubsubsection ()
 
void endSubsubsection ()
 
void startCenter ()
 
void endCenter ()
 
void startSmall ()
 
void endSmall ()
 
void startMemberDescription (const char *, const char *, bool)
 
void endMemberDescription ()
 
void startMemberDeclaration ()
 
void endMemberDeclaration (const char *, const char *)
 
void writeInheritedSectionTitle (const char *, const char *, const char *, const char *, const char *, const char *)
 
void startDescList (SectionTypes)
 
void endDescList ()
 
void startExamples ()
 
void endExamples ()
 
void startParamList (ParamListTypes, const char *title)
 
void endParamList ()
 
void startDescForItem ()
 
void endDescForItem ()
 
void startSection (const char *, const char *, SectionType)
 
void endSection (const char *, SectionType)
 
void addIndexItem (const char *, const char *)
 
void startIndent ()
 
void endIndent ()
 
void writeSynopsis ()
 
void startClassDiagram ()
 
void endClassDiagram (const ClassDiagram &, const char *, const char *)
 
void startPageRef ()
 
void endPageRef (const char *, const char *)
 
void startQuickIndices ()
 
void endQuickIndices ()
 
void writeSplitBar (const char *)
 
void writeNavigationPath (const char *)
 
void writeLogo ()
 
void writeQuickLinks (bool, HighlightedItem, const char *)
 
void writeSummaryLink (const char *, const char *, const char *, bool)
 
void startContents ()
 
void endContents ()
 
void writeNonBreakableSpace (int n)
 
void startDescTable (const char *t)
 
void endDescTable ()
 
void startDescTableRow ()
 
void endDescTableRow ()
 
void startDescTableTitle ()
 
void endDescTableTitle ()
 
void startDescTableData ()
 
void endDescTableData ()
 
void startDotGraph ()
 
void endDotGraph (DotClassGraph &)
 
void startInclDepGraph ()
 
void endInclDepGraph (DotInclDepGraph &)
 
void startGroupCollaboration ()
 
void endGroupCollaboration (DotGroupCollaboration &)
 
void startCallGraph ()
 
void endCallGraph (DotCallGraph &)
 
void startDirDepGraph ()
 
void endDirDepGraph (DotDirDeps &)
 
void writeGraphicalHierarchy (DotGfxHierarchyTable &)
 
void startTextBlock (bool)
 
void endTextBlock (bool)
 
void lastIndexPage ()
 
void startMemberDocPrefixItem ()
 
void endMemberDocPrefixItem ()
 
void startMemberDocName (bool)
 
void endMemberDocName ()
 
void startParameterType (bool, const char *)
 
void endParameterType ()
 
void startParameterName (bool)
 
void endParameterName (bool, bool, bool)
 
void startParameterList (bool)
 
void endParameterList ()
 
void exceptionEntry (const char *, bool)
 
void startFontClass (const char *)
 
void endFontClass ()
 
void startConstraintList (const char *)
 
void startConstraintParam ()
 
void endConstraintParam ()
 
void startConstraintType ()
 
void endConstraintType ()
 
void startConstraintDocs ()
 
void endConstraintDocs ()
 
void endConstraintList ()
 
void startMemberDocSimple (bool)
 
void endMemberDocSimple (bool)
 
void startInlineMemberType ()
 
void endInlineMemberType ()
 
void startInlineMemberName ()
 
void endInlineMemberName ()
 
void startInlineMemberDoc ()
 
void endInlineMemberDoc ()
 
void startLabels ()
 
void writeLabel (const char *l, bool isLast)
 
void endLabels ()
 
void writeCodeAnchor (const char *)
 
void setCurrentDoc (const Definition *, const char *, bool)
 
void addWord (const char *, bool)
 
- Public Member Functions inherited from OutputGenerator
 OutputGenerator ()
 Copyright (C) 1997-2015 by Dimitri van Heesch. More...
 
virtual ~OutputGenerator ()
 
void startPlainFile (const char *name)
 
void endPlainFile ()
 
bool isEnabled () const
 
void pushGeneratorState ()
 
void popGeneratorState ()
 
virtual void startPageDoc (const char *)
 
virtual void endPageDoc ()
 
- Public Member Functions inherited from BaseOutputDocInterface
virtual ~BaseOutputDocInterface ()
 
virtual void parseText (const QCString &)
 
- Public Member Functions inherited from CodeOutputInterface
virtual ~CodeOutputInterface ()
 

Static Public Member Functions

static void init ()
 

Private Member Functions

 ManGenerator (const ManGenerator &g)
 
ManGeneratoroperator= (const ManGenerator &g)
 

Private Attributes

bool m_firstCol
 
bool m_paragraph
 
int m_col
 
bool m_upperCase
 
bool m_insideTabbing
 
bool m_inHeader
 

Additional Inherited Members

- Public Types inherited from OutputGenerator
enum  OutputType {
  Html, Latex, Man, RTF,
  XML, DEF, Perl, Docbook
}
 
- Public Types inherited from BaseOutputDocInterface
enum  ParamListTypes { Param, RetVal, Exception }
 
enum  SectionTypes { EnumValues, Examples }
 
- Protected Attributes inherited from OutputGenerator
FTextStream t
 
QFilem_file
 
QCString m_fileName
 
QCString m_dir
 
bool m_active
 
QStack< bool > * m_genStack
 

Detailed Description

Generator for Man page output.

Definition at line 26 of file mangen.h.

Constructor & Destructor Documentation

◆ ManGenerator() [1/2]

ManGenerator::ManGenerator ( )

◆ ~ManGenerator()

ManGenerator::~ManGenerator ( )

Definition at line 88 of file mangen.cpp.

◆ ManGenerator() [2/2]

ManGenerator::ManGenerator ( const ManGenerator g)
private

Member Function Documentation

◆ addIndexItem()

void ManGenerator::addIndexItem ( const char *  ,
const char *   
)
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 181 of file mangen.h.

◆ addWord()

void ManGenerator::addWord ( const char *  ,
bool   
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 264 of file mangen.h.

◆ clearBuffer()

void ManGenerator::clearBuffer ( )

◆ codify()

void ManGenerator::codify ( const char *  s)
virtual

Writes an code fragment to the output. This function should keep spaces visible, should break lines at a newline and should convert tabs to the right number of spaces.

Implements CodeOutputInterface.

Definition at line 305 of file mangen.cpp.

References Config_getInt, FALSE, QCString::left(), m_col, m_firstCol, m_paragraph, Doxygen::spaces, OutputGenerator::t, TRUE, and writeUtf8Char().

Referenced by endCodeLine().

◆ disable()

void ManGenerator::disable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 37 of file mangen.h.

References FALSE, and OutputGenerator::m_active.

Referenced by disableIf(), and disableIfNot().

◆ disableIf()

void ManGenerator::disableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 39 of file mangen.h.

References disable(), and OutputGenerator::Man.

◆ disableIfNot()

void ManGenerator::disableIfNot ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 40 of file mangen.h.

References disable(), and OutputGenerator::Man.

◆ docify()

void ManGenerator::docify ( const char *  s)
virtual

Writes an ASCII string to the output. Converts characters that have A special meaning, like & in html.

Implements BaseOutputDocInterface.

Definition at line 281 of file mangen.cpp.

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

Referenced by startConstraintList(), startDescTable(), startExamples(), startMemberDocSimple(), startParamList(), writeCodeLink(), writeObjectLink(), and writeString().

◆ enable()

void ManGenerator::enable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 35 of file mangen.h.

References OutputGenerator::m_active, OutputGenerator::m_genStack, QStack< type >::top(), and TRUE.

Referenced by enableIf().

◆ enableIf()

void ManGenerator::enableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 38 of file mangen.h.

References enable(), and OutputGenerator::Man.

◆ endAnonTypeScope()

void ManGenerator::endAnonTypeScope ( int  indentLevel)
virtual

Implements OutputGenerator.

Definition at line 528 of file mangen.cpp.

References FALSE, and m_insideTabbing.

◆ endBold()

void ManGenerator::endBold ( )
inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

Definition at line 141 of file mangen.h.

References FALSE, m_firstCol, and OutputGenerator::t.

Referenced by endDescTableTitle(), startConstraintList(), startDescTable(), startExamples(), startParamList(), and writeObjectLink().

◆ endCallGraph()

void ManGenerator::endCallGraph ( DotCallGraph )
inlinevirtual

Implements OutputGenerator.

Definition at line 216 of file mangen.h.

◆ endCenter()

void ManGenerator::endCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 161 of file mangen.h.

◆ endClassDiagram()

void ManGenerator::endClassDiagram ( const ClassDiagram ,
const char *  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 186 of file mangen.h.

◆ endCodeFragment()

void ManGenerator::endCodeFragment ( )
virtual

Ends a source code fragment

Implements BaseOutputDocInterface.

Definition at line 394 of file mangen.cpp.

References endl(), FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::t, and TRUE.

◆ endCodeLine()

void ManGenerator::endCodeLine ( )
inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

Definition at line 137 of file mangen.h.

References codify(), and m_col.

◆ endConstraintDocs()

void ManGenerator::endConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 741 of file mangen.cpp.

References endl(), m_firstCol, OutputGenerator::t, and TRUE.

◆ endConstraintList()

void ManGenerator::endConstraintList ( )
virtual

Implements OutputGenerator.

Definition at line 746 of file mangen.cpp.

◆ endConstraintParam()

void ManGenerator::endConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 720 of file mangen.cpp.

References endEmphasis(), endItemListItem(), and OutputGenerator::t.

◆ endConstraintType()

void ManGenerator::endConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 732 of file mangen.cpp.

References endEmphasis().

◆ endContents()

void ManGenerator::endContents ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 197 of file mangen.h.

◆ endDescForItem()

void ManGenerator::endDescForItem ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 510 of file mangen.cpp.

Referenced by endDescTable().

◆ endDescItem()

void ManGenerator::endDescItem ( )
virtual

Ends an item of a description list and starts the description itself: e.g. </dt> in HTML.

Implements BaseOutputDocInterface.

Definition at line 514 of file mangen.cpp.

References endl(), m_firstCol, OutputGenerator::t, and TRUE.

◆ endDescList()

void ManGenerator::endDescList ( )
inline

Definition at line 171 of file mangen.h.

◆ endDescription()

void ManGenerator::endDescription ( )
inlinevirtual

Ends a description list: e.g. </dl> in HTML

Implements BaseOutputDocInterface.

Definition at line 143 of file mangen.h.

◆ endDescTable()

void ManGenerator::endDescTable ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 668 of file mangen.cpp.

References endDescForItem().

◆ endDescTableData()

void ManGenerator::endDescTableData ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 207 of file mangen.h.

◆ endDescTableRow()

void ManGenerator::endDescTableRow ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 203 of file mangen.h.

◆ endDescTableTitle()

void ManGenerator::endDescTableTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 205 of file mangen.h.

References endBold(), and endEmphasis().

◆ endDirDepGraph()

void ManGenerator::endDirDepGraph ( DotDirDeps )
inlinevirtual

Implements OutputGenerator.

Definition at line 218 of file mangen.h.

◆ endDotGraph()

void ManGenerator::endDotGraph ( DotClassGraph )
inlinevirtual

Implements OutputGenerator.

Definition at line 210 of file mangen.h.

◆ endDoxyAnchor()

void ManGenerator::endDoxyAnchor ( const char *  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 151 of file mangen.h.

◆ endEmphasis()

void ManGenerator::endEmphasis ( )
inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 139 of file mangen.h.

References FALSE, m_firstCol, and OutputGenerator::t.

Referenced by endConstraintParam(), endConstraintType(), and endDescTableTitle().

◆ endExamples()

void ManGenerator::endExamples ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 649 of file mangen.cpp.

◆ endFile()

void ManGenerator::endFile ( )
virtual

Implements OutputGenerator.

Definition at line 156 of file mangen.cpp.

References endl(), OutputGenerator::endPlainFile(), and OutputGenerator::t.

◆ endFontClass()

void ManGenerator::endFontClass ( )
inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

Definition at line 238 of file mangen.h.

◆ endGroupCollaboration()

void ManGenerator::endGroupCollaboration ( DotGroupCollaboration )
inlinevirtual

Implements OutputGenerator.

Definition at line 214 of file mangen.h.

◆ endGroupHeader()

void ManGenerator::endGroupHeader ( int  )
virtual

Implements OutputGenerator.

Definition at line 260 of file mangen.cpp.

References endl(), FALSE, m_firstCol, m_paragraph, m_upperCase, OutputGenerator::t, and TRUE.

Referenced by endSection().

◆ endHeaderSection()

void ManGenerator::endHeaderSection ( )
virtual

Implements OutputGenerator.

Definition at line 838 of file mangen.cpp.

◆ endHtmlLink()

void ManGenerator::endHtmlLink ( )
virtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 243 of file mangen.cpp.

◆ endInclDepGraph()

void ManGenerator::endInclDepGraph ( DotInclDepGraph )
inlinevirtual

Implements OutputGenerator.

Definition at line 212 of file mangen.h.

◆ endIndent()

void ManGenerator::endIndent ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 183 of file mangen.h.

◆ endIndexItem()

void ManGenerator::endIndexItem ( const char *  ref,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 217 of file mangen.cpp.

◆ endIndexKey()

void ManGenerator::endIndexKey ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 73 of file mangen.h.

◆ endIndexList()

void ManGenerator::endIndexList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 71 of file mangen.h.

References newParagraph().

◆ endIndexListItem()

void ManGenerator::endIndexListItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 69 of file mangen.h.

◆ endIndexSection()

void ManGenerator::endIndexSection ( IndexSections  )
inlinevirtual

Implements OutputGenerator.

Definition at line 54 of file mangen.h.

◆ endIndexValue()

void ManGenerator::endIndexValue ( const char *  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 75 of file mangen.h.

◆ endInlineHeader()

void ManGenerator::endInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 760 of file mangen.cpp.

References endl(), FALSE, m_firstCol, and OutputGenerator::t.

◆ endInlineMemberDoc()

void ManGenerator::endInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 816 of file mangen.cpp.

References endl(), m_firstCol, OutputGenerator::t, and TRUE.

◆ endInlineMemberName()

void ManGenerator::endInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 807 of file mangen.cpp.

References OutputGenerator::t.

◆ endInlineMemberType()

void ManGenerator::endInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 797 of file mangen.cpp.

References OutputGenerator::t.

◆ endItemList()

void ManGenerator::endItemList ( )
inlinevirtual

Ends a bullet list: e.g. </ul> in html

Implements BaseOutputDocInterface.

Definition at line 77 of file mangen.h.

References newParagraph().

◆ endItemListItem()

void ManGenerator::endItemListItem ( )
virtual

Writes a list item for a bullet or enumerated list: e.g. </li> in html

Implements BaseOutputDocInterface.

Definition at line 382 of file mangen.cpp.

Referenced by endConstraintParam(), and startDescTableTitle().

◆ endLabels()

void ManGenerator::endLabels ( )
virtual

Implements OutputGenerator.

Definition at line 834 of file mangen.cpp.

◆ endMemberDeclaration()

void ManGenerator::endMemberDeclaration ( const char *  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 167 of file mangen.h.

◆ endMemberDescription()

void ManGenerator::endMemberDescription ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 165 of file mangen.h.

References FALSE, m_firstCol, and OutputGenerator::t.

◆ endMemberDoc()

void ManGenerator::endMemberDoc ( bool  )
virtual

Implements OutputGenerator.

Definition at line 447 of file mangen.cpp.

References OutputGenerator::t.

◆ endMemberDocList()

void ManGenerator::endMemberDocList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 112 of file mangen.h.

◆ endMemberDocName()

void ManGenerator::endMemberDocName ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 228 of file mangen.h.

◆ endMemberDocPrefixItem()

void ManGenerator::endMemberDocPrefixItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 226 of file mangen.h.

◆ endMemberDocSimple()

void ManGenerator::endMemberDocSimple ( bool  )
virtual

Implements OutputGenerator.

Definition at line 785 of file mangen.cpp.

References endl(), m_firstCol, OutputGenerator::t, and TRUE.

◆ endMemberGroup()

void ManGenerator::endMemberGroup ( bool  )
virtual

Implements OutputGenerator.

Definition at line 590 of file mangen.cpp.

References FALSE, m_firstCol, and OutputGenerator::t.

◆ endMemberGroupDocs()

void ManGenerator::endMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 580 of file mangen.cpp.

References OutputGenerator::t.

◆ endMemberGroupHeader()

void ManGenerator::endMemberGroupHeader ( )
virtual

Implements OutputGenerator.

Definition at line 570 of file mangen.cpp.

References m_firstCol, OutputGenerator::t, and TRUE.

◆ endMemberHeader()

void ManGenerator::endMemberHeader ( )
virtual

Implements OutputGenerator.

Definition at line 274 of file mangen.cpp.

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

Referenced by endSection().

◆ endMemberItem()

void ManGenerator::endMemberItem ( )
virtual

Implements OutputGenerator.

Definition at line 544 of file mangen.cpp.

References OutputGenerator::t.

◆ endMemberList()

void ManGenerator::endMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 557 of file mangen.cpp.

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

◆ endMemberSections()

void ManGenerator::endMemberSections ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 99 of file mangen.h.

◆ endMemberSubtitle()

void ManGenerator::endMemberSubtitle ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 107 of file mangen.h.

◆ endMemberTemplateParams()

void ManGenerator::endMemberTemplateParams ( const char *  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 122 of file mangen.h.

◆ endPageRef()

void ManGenerator::endPageRef ( const char *  ,
const char *   
)
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 188 of file mangen.h.

◆ endParagraph()

void ManGenerator::endParagraph ( )
virtual

Ends a paragraph

Implements BaseOutputDocInterface.

Definition at line 204 of file mangen.cpp.

◆ endParameterList()

void ManGenerator::endParameterList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 234 of file mangen.h.

◆ endParameterName()

void ManGenerator::endParameterName ( bool  ,
bool  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 232 of file mangen.h.

◆ endParameterType()

void ManGenerator::endParameterType ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 230 of file mangen.h.

◆ endParamList()

void ManGenerator::endParamList ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 687 of file mangen.cpp.

◆ endProjectNumber()

void ManGenerator::endProjectNumber ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 57 of file mangen.h.

◆ endQuickIndices()

void ManGenerator::endQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 190 of file mangen.h.

◆ endSection()

void ManGenerator::endSection ( const char *  ,
SectionType  type 
)
virtual

◆ endSmall()

void ManGenerator::endSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 163 of file mangen.h.

◆ endSubsection()

void ManGenerator::endSubsection ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 460 of file mangen.cpp.

References OutputGenerator::t.

◆ endSubsubsection()

void ManGenerator::endSubsubsection ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 474 of file mangen.cpp.

References OutputGenerator::t.

◆ endTextBlock()

void ManGenerator::endTextBlock ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 222 of file mangen.h.

◆ endTextLink()

void ManGenerator::endTextLink ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 91 of file mangen.h.

◆ endTitle()

void ManGenerator::endTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 368 of file mangen.cpp.

References OutputGenerator::t.

◆ endTitleHead()

void ManGenerator::endTitleHead ( const char *  ,
const char *  name 
)
virtual

◆ endTypewriter()

void ManGenerator::endTypewriter ( )
inlinevirtual

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

Definition at line 95 of file mangen.h.

References FALSE, m_firstCol, and OutputGenerator::t.

◆ exceptionEntry()

void ManGenerator::exceptionEntry ( const char *  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 235 of file mangen.h.

◆ get()

OutputGenerator* ManGenerator::get ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 42 of file mangen.h.

References OutputGenerator::Man.

◆ init()

void ManGenerator::init ( )
static

◆ insertMemberAlign()

void ManGenerator::insertMemberAlign ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 104 of file mangen.h.

◆ insertMemberAlignLeft()

void ManGenerator::insertMemberAlignLeft ( int  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 105 of file mangen.h.

◆ isEnabled()

bool ManGenerator::isEnabled ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 41 of file mangen.h.

References OutputGenerator::m_active, and OutputGenerator::Man.

◆ lastIndexPage()

void ManGenerator::lastIndexPage ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 223 of file mangen.h.

◆ lineBreak()

void ManGenerator::lineBreak ( const char *  )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 146 of file mangen.h.

References endl(), and OutputGenerator::t.

◆ newParagraph()

void ManGenerator::newParagraph ( )

Definition at line 182 of file mangen.cpp.

References endl(), m_firstCol, m_paragraph, OutputGenerator::t, and TRUE.

Referenced by endIndexList(), endItemList(), and startCodeFragment().

◆ operator=()

ManGenerator& ManGenerator::operator= ( const ManGenerator g)
private

◆ setCurrentDoc()

void ManGenerator::setCurrentDoc ( const Definition ,
const char *  ,
bool   
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 263 of file mangen.h.

◆ startAnonTypeScope()

void ManGenerator::startAnonTypeScope ( int  indentLevel)
virtual

Implements OutputGenerator.

Definition at line 520 of file mangen.cpp.

References m_insideTabbing, and TRUE.

◆ startBold()

void ManGenerator::startBold ( )
inlinevirtual

Changes the text font to bold face. The bold section ends with endBold()

Implements BaseOutputDocInterface.

Definition at line 140 of file mangen.h.

References FALSE, m_firstCol, and OutputGenerator::t.

Referenced by startConstraintList(), startDescList(), startDescTable(), startDescTableTitle(), startExamples(), startParamList(), and writeObjectLink().

◆ startCallGraph()

void ManGenerator::startCallGraph ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 215 of file mangen.h.

◆ startCenter()

void ManGenerator::startCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 160 of file mangen.h.

◆ startClassDiagram()

void ManGenerator::startClassDiagram ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 185 of file mangen.h.

◆ startCodeFragment()

void ManGenerator::startCodeFragment ( )
virtual

Starts a source code fragment. The fragment will be fed to the code parser (see code.h) for syntax highlighting and cross-referencing. The fragment ends by a call to endCodeFragment()

Implements BaseOutputDocInterface.

Definition at line 386 of file mangen.cpp.

References endl(), FALSE, m_firstCol, m_paragraph, newParagraph(), OutputGenerator::t, and TRUE.

◆ startCodeLine()

void ManGenerator::startCodeLine ( bool  )
inlinevirtual

Implements CodeOutputInterface.

Definition at line 136 of file mangen.h.

◆ startConstraintDocs()

void ManGenerator::startConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 737 of file mangen.cpp.

◆ startConstraintList()

void ManGenerator::startConstraintList ( const char *  header)
virtual

Implements OutputGenerator.

Definition at line 700 of file mangen.cpp.

References docify(), endBold(), endl(), FALSE, m_col, m_firstCol, m_paragraph, startBold(), OutputGenerator::t, and TRUE.

◆ startConstraintParam()

void ManGenerator::startConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 714 of file mangen.cpp.

References startEmphasis(), and startItemListItem().

◆ startConstraintType()

void ManGenerator::startConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 727 of file mangen.cpp.

References startEmphasis().

◆ startContents()

void ManGenerator::startContents ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 196 of file mangen.h.

◆ startDescForItem()

void ManGenerator::startDescForItem ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 500 of file mangen.cpp.

References endl(), FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::t, and TRUE.

Referenced by startDescTable().

◆ startDescItem()

void ManGenerator::startDescItem ( )
virtual

Starts an item of a description list: e.g. <dt> in HTML.

Implements BaseOutputDocInterface.

Definition at line 487 of file mangen.cpp.

References endl(), FALSE, m_firstCol, and OutputGenerator::t.

◆ startDescList()

void ManGenerator::startDescList ( SectionTypes  )

Definition at line 349 of file mangen.cpp.

References endl(), FALSE, m_col, m_firstCol, m_paragraph, startBold(), OutputGenerator::t, and TRUE.

◆ startDescription()

void ManGenerator::startDescription ( )
inlinevirtual

Starts a description list: e.g. <dl> in HTML Items are surrounded by startDescItem() and endDescItem()

Implements BaseOutputDocInterface.

Definition at line 142 of file mangen.h.

◆ startDescTable()

void ManGenerator::startDescTable ( const char *  t)
virtual

◆ startDescTableData()

void ManGenerator::startDescTableData ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 206 of file mangen.h.

References endl(), m_firstCol, OutputGenerator::t, and TRUE.

◆ startDescTableRow()

void ManGenerator::startDescTableRow ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 202 of file mangen.h.

◆ startDescTableTitle()

void ManGenerator::startDescTableTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 204 of file mangen.h.

References endItemListItem(), startBold(), startEmphasis(), and startItemListItem().

◆ startDirDepGraph()

void ManGenerator::startDirDepGraph ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 217 of file mangen.h.

◆ startDotGraph()

void ManGenerator::startDotGraph ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 209 of file mangen.h.

◆ startDoxyAnchor()

void ManGenerator::startDoxyAnchor ( const char *  ,
const char *  manName,
const char *  ,
const char *  name,
const char *   
)
virtual

◆ startEmphasis()

void ManGenerator::startEmphasis ( )
inlinevirtual

Changes the text font to italic. The italic section ends with endEmphasis()

Implements BaseOutputDocInterface.

Definition at line 138 of file mangen.h.

References FALSE, m_firstCol, and OutputGenerator::t.

Referenced by startConstraintParam(), startConstraintType(), and startDescTableTitle().

◆ startExamples()

void ManGenerator::startExamples ( )
virtual

◆ startFile()

void ManGenerator::startFile ( const char *  name,
const char *  manName,
const char *  title 
)
virtual

Implements OutputGenerator.

Definition at line 150 of file mangen.cpp.

References buildFileName(), m_firstCol, OutputGenerator::startPlainFile(), and TRUE.

◆ startFontClass()

void ManGenerator::startFontClass ( const char *  clsName)
inlinevirtual

Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.

Parameters
clsNameThe category name.

Implements CodeOutputInterface.

Definition at line 237 of file mangen.h.

◆ startGroupCollaboration()

void ManGenerator::startGroupCollaboration ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 213 of file mangen.h.

◆ startGroupHeader()

void ManGenerator::startGroupHeader ( int  )
virtual

Implements OutputGenerator.

Definition at line 252 of file mangen.cpp.

References endl(), FALSE, m_firstCol, m_upperCase, OutputGenerator::t, and TRUE.

Referenced by startSection().

◆ startHeaderSection()

void ManGenerator::startHeaderSection ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 100 of file mangen.h.

◆ startHtmlLink()

void ManGenerator::startHtmlLink ( const char *  url)
virtual

Starts a (link to an) URL found in the documentation.

Parameters
urlThe URL to link to.

Implements BaseOutputDocInterface.

Definition at line 239 of file mangen.cpp.

◆ startInclDepGraph()

void ManGenerator::startInclDepGraph ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 211 of file mangen.h.

◆ startIndent()

void ManGenerator::startIndent ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 182 of file mangen.h.

◆ startIndexItem()

void ManGenerator::startIndexItem ( const char *  ref,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 213 of file mangen.cpp.

◆ startIndexKey()

void ManGenerator::startIndexKey ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 72 of file mangen.h.

◆ startIndexList()

void ManGenerator::startIndexList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 70 of file mangen.h.

◆ startIndexListItem()

void ManGenerator::startIndexListItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 68 of file mangen.h.

◆ startIndexSection()

void ManGenerator::startIndexSection ( IndexSections  )
inlinevirtual

Implements OutputGenerator.

Definition at line 53 of file mangen.h.

◆ startIndexValue()

void ManGenerator::startIndexValue ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 74 of file mangen.h.

◆ startInlineHeader()

void ManGenerator::startInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 751 of file mangen.cpp.

References endl(), m_firstCol, and OutputGenerator::t.

◆ startInlineMemberDoc()

void ManGenerator::startInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 812 of file mangen.cpp.

◆ startInlineMemberName()

void ManGenerator::startInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 802 of file mangen.cpp.

References OutputGenerator::t.

◆ startInlineMemberType()

void ManGenerator::startInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 793 of file mangen.cpp.

◆ startItemList()

void ManGenerator::startItemList ( )
inlinevirtual

Start of a bullet list: e.g. <ul> in html. startItemListItem() is Used for the bullet items.

Implements BaseOutputDocInterface.

Definition at line 76 of file mangen.h.

◆ startItemListItem()

void ManGenerator::startItemListItem ( )
virtual

Writes a list item for a bullet or enumerated list: e.g. <li> in html

Implements BaseOutputDocInterface.

Definition at line 373 of file mangen.cpp.

References endl(), FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::t, and TRUE.

Referenced by startConstraintParam(), and startDescTableTitle().

◆ startLabels()

void ManGenerator::startLabels ( )
virtual

Implements OutputGenerator.

Definition at line 824 of file mangen.cpp.

◆ startMemberDeclaration()

void ManGenerator::startMemberDeclaration ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 166 of file mangen.h.

◆ startMemberDescription()

void ManGenerator::startMemberDescription ( const char *  ,
const char *  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 164 of file mangen.h.

References FALSE, m_firstCol, and OutputGenerator::t.

◆ startMemberDoc()

void ManGenerator::startMemberDoc ( const char *  ,
const char *  ,
const char *  ,
const char *  ,
int  ,
int  ,
bool   
)
virtual

Implements OutputGenerator.

Definition at line 403 of file mangen.cpp.

References endl(), FALSE, m_firstCol, m_paragraph, and OutputGenerator::t.

◆ startMemberDocList()

void ManGenerator::startMemberDocList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 111 of file mangen.h.

◆ startMemberDocName()

void ManGenerator::startMemberDocName ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 227 of file mangen.h.

◆ startMemberDocPrefixItem()

void ManGenerator::startMemberDocPrefixItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 225 of file mangen.h.

◆ startMemberDocSimple()

void ManGenerator::startMemberDocSimple ( bool  isEnum)
virtual

◆ startMemberGroup()

void ManGenerator::startMemberGroup ( )
virtual

Implements OutputGenerator.

Definition at line 585 of file mangen.cpp.

References OutputGenerator::t.

◆ startMemberGroupDocs()

void ManGenerator::startMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 576 of file mangen.cpp.

◆ startMemberGroupHeader()

void ManGenerator::startMemberGroupHeader ( bool  )
virtual

Implements OutputGenerator.

Definition at line 565 of file mangen.cpp.

References OutputGenerator::t.

◆ startMemberHeader()

void ManGenerator::startMemberHeader ( const char *  ,
int   
)
virtual

Implements OutputGenerator.

Definition at line 268 of file mangen.cpp.

References endl(), m_firstCol, and OutputGenerator::t.

Referenced by startSection().

◆ startMemberItem()

void ManGenerator::startMemberItem ( const char *  ,
int  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 537 of file mangen.cpp.

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

◆ startMemberList()

void ManGenerator::startMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 549 of file mangen.cpp.

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

◆ startMemberSections()

void ManGenerator::startMemberSections ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 98 of file mangen.h.

◆ startMemberSubtitle()

void ManGenerator::startMemberSubtitle ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 106 of file mangen.h.

◆ startMemberTemplateParams()

void ManGenerator::startMemberTemplateParams ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 121 of file mangen.h.

◆ startPageRef()

void ManGenerator::startPageRef ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 187 of file mangen.h.

◆ startParagraph()

void ManGenerator::startParagraph ( const char *  classDef)
virtual

Starts a new paragraph

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 193 of file mangen.cpp.

References endl(), m_firstCol, m_paragraph, OutputGenerator::t, and TRUE.

◆ startParameterList()

void ManGenerator::startParameterList ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 233 of file mangen.h.

◆ startParameterName()

void ManGenerator::startParameterName ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 231 of file mangen.h.

◆ startParameterType()

void ManGenerator::startParameterType ( bool  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 229 of file mangen.h.

◆ startParamList()

void ManGenerator::startParamList ( ParamListTypes  ,
const char *  title 
)
virtual

◆ startProjectNumber()

void ManGenerator::startProjectNumber ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 56 of file mangen.h.

◆ startQuickIndices()

void ManGenerator::startQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 189 of file mangen.h.

◆ startSection()

void ManGenerator::startSection ( const char *  ,
const char *  ,
SectionType  type 
)
virtual

◆ startSmall()

void ManGenerator::startSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 162 of file mangen.h.

◆ startSubsection()

void ManGenerator::startSubsection ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 452 of file mangen.cpp.

References endl(), FALSE, m_firstCol, m_paragraph, and OutputGenerator::t.

◆ startSubsubsection()

void ManGenerator::startSubsubsection ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 466 of file mangen.cpp.

References endl(), FALSE, m_firstCol, m_paragraph, and OutputGenerator::t.

◆ startTextBlock()

void ManGenerator::startTextBlock ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 221 of file mangen.h.

◆ startTextLink()

void ManGenerator::startTextLink ( const char *  ,
const char *   
)
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 90 of file mangen.h.

◆ startTitle()

void ManGenerator::startTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 360 of file mangen.cpp.

References endl(), FALSE, m_firstCol, m_paragraph, and OutputGenerator::t.

◆ startTitleHead()

void ManGenerator::startTitleHead ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 59 of file mangen.h.

◆ startTypewriter()

void ManGenerator::startTypewriter ( )
inlinevirtual

Changes the text font to fixed size. The section ends with endTypewriter()

Implements BaseOutputDocInterface.

Definition at line 94 of file mangen.h.

References FALSE, m_firstCol, and OutputGenerator::t.

◆ writeAnchor()

void ManGenerator::writeAnchor ( const char *  ,
const char *   
)
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 132 of file mangen.h.

◆ writeChar()

void ManGenerator::writeChar ( char  c)
virtual

Writes a single ASCII character to the output. Converts characters that have a special meaning.

Implements BaseOutputDocInterface.

Definition at line 335 of file mangen.cpp.

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

◆ writeCodeAnchor()

void ManGenerator::writeCodeAnchor ( const char *  name)
inlinevirtual

Write an anchor to a source listing.

Parameters
nameThe name of the anchor.

Implements CodeOutputInterface.

Definition at line 262 of file mangen.h.

◆ writeCodeLink()

void ManGenerator::writeCodeLink ( const char *  ref,
const char *  file,
const char *  anchor,
const char *  name,
const char *  tooltip 
)
virtual

Writes a link to an object in a code fragment.

Parameters
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.
tooltipThe tooltip to display when the mouse is on the link.

Implements CodeOutputInterface.

Definition at line 232 of file mangen.cpp.

References docify().

◆ writeDoc()

void ManGenerator::writeDoc ( DocNode n,
const Definition ctx,
const MemberDef  
)
virtual

◆ writeEndAnnoItem()

void ManGenerator::writeEndAnnoItem ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 155 of file mangen.h.

References endl(), m_firstCol, OutputGenerator::t, and TRUE.

◆ writeFooter()

void ManGenerator::writeFooter ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 49 of file mangen.h.

◆ writeGraphicalHierarchy()

void ManGenerator::writeGraphicalHierarchy ( DotGfxHierarchyTable )
inlinevirtual

Implements OutputGenerator.

Definition at line 219 of file mangen.h.

◆ writeInheritedSectionTitle()

void ManGenerator::writeInheritedSectionTitle ( const char *  ,
const char *  ,
const char *  ,
const char *  ,
const char *  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 168 of file mangen.h.

◆ writeLabel()

void ManGenerator::writeLabel ( const char *  l,
bool  isLast 
)
virtual

Implements OutputGenerator.

Definition at line 828 of file mangen.cpp.

References languages::l, and OutputGenerator::t.

◆ writeLatexSpacing()

void ManGenerator::writeLatexSpacing ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 152 of file mangen.h.

◆ writeLineNumber()

void ManGenerator::writeLineNumber ( const char *  ref,
const char *  file,
const char *  anchor,
int  lineNumber 
)
inlinevirtual

Writes the line number of a source listing

Parameters
refExternal reference (when imported from a tag file)
fileThe file part of the URL pointing to the docs.
anchorThe anchor part of the URL pointing to the docs.
lineNumberThe line number to write

Implements CodeOutputInterface.

Definition at line 135 of file mangen.h.

References languages::l, m_col, and OutputGenerator::t.

◆ writeLogo()

void ManGenerator::writeLogo ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 193 of file mangen.h.

◆ writeNavigationPath()

void ManGenerator::writeNavigationPath ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 192 of file mangen.h.

◆ writeNonBreakableSpace()

void ManGenerator::writeNonBreakableSpace ( int  n)
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 198 of file mangen.h.

References OutputGenerator::t.

◆ writeObjectLink()

void ManGenerator::writeObjectLink ( const char *  ref,
const char *  file,
const char *  anchor,
const char *  name 
)
virtual

Writes a link to an object in the documentation.

Parameters
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.

Implements BaseOutputDocInterface.

Definition at line 226 of file mangen.cpp.

References docify(), endBold(), and startBold().

◆ writePageLink()

void ManGenerator::writePageLink ( const char *  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 55 of file mangen.h.

◆ writeQuickLinks()

void ManGenerator::writeQuickLinks ( bool  ,
HighlightedItem  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 194 of file mangen.h.

◆ writeRuler()

void ManGenerator::writeRuler ( )
inlinevirtual

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

Definition at line 131 of file mangen.h.

◆ writeSearchInfo()

void ManGenerator::writeSearchInfo ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 48 of file mangen.h.

◆ writeSplitBar()

void ManGenerator::writeSplitBar ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 191 of file mangen.h.

◆ writeStartAnnoItem()

void ManGenerator::writeStartAnnoItem ( const char *  type,
const char *  file,
const char *  path,
const char *  name 
)
virtual

Implements OutputGenerator.

Definition at line 221 of file mangen.cpp.

◆ writeString()

void ManGenerator::writeString ( const char *  text)
virtual

Writes an ASCII string to the output, without converting special characters.

Implements BaseOutputDocInterface.

Definition at line 208 of file mangen.cpp.

References docify().

◆ writeStyleInfo()

void ManGenerator::writeStyleInfo ( int  )
inlinevirtual

Implements OutputGenerator.

Definition at line 58 of file mangen.h.

◆ writeSummaryLink()

void ManGenerator::writeSummaryLink ( const char *  ,
const char *  ,
const char *  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 195 of file mangen.h.

◆ writeSynopsis()

void ManGenerator::writeSynopsis ( )
virtual

Implements OutputGenerator.

Definition at line 479 of file mangen.cpp.

References endl(), FALSE, m_firstCol, m_paragraph, OutputGenerator::t, and TRUE.

◆ writeTooltip()

void ManGenerator::writeTooltip ( const char *  id,
const DocLinkInfo docInfo,
const char *  decl,
const char *  desc,
const SourceLinkInfo defInfo,
const SourceLinkInfo declInfo 
)
inlinevirtual

Writes a tool tip definition

Parameters
idunique identifier for the tooltip
docInfoInfo about the symbol's documentation.
declfull declaration of the symbol (for functions)
descbrief description for the symbol
defInfoInfo about the symbol's definition in the source code
declInfoInfo about the symbol's declaration in the source code

Implements CodeOutputInterface.

Definition at line 87 of file mangen.h.

Member Data Documentation

◆ m_col

◆ m_firstCol

◆ m_inHeader

bool ManGenerator::m_inHeader
private

Definition at line 272 of file mangen.h.

Referenced by endSection(), endTitleHead(), ManGenerator(), and startSection().

◆ m_insideTabbing

bool ManGenerator::m_insideTabbing
private

◆ m_paragraph

◆ m_upperCase

bool ManGenerator::m_upperCase
private

Definition at line 270 of file mangen.h.

Referenced by endGroupHeader(), ManGenerator(), and startGroupHeader().


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