doxygen
Public Member Functions | Static Public Member Functions | List of all members
ManGenerator Class Reference

Generator for Man page output. More...

#include <mangen.h>

Inheritance diagram for ManGenerator:
Inheritance graph
[legend]
Collaboration diagram for ManGenerator:
Collaboration graph
[legend]

Public Member Functions

 ManGenerator (const ManGenerator &g)
 
ManGeneratoroperator= (const ManGenerator &g)
 
virtual std::unique_ptr< OutputGeneratorclone () const
 
OutputType type () const
 
void writeDoc (DocNode *, const Definition *, const MemberDef *, int)
 
void cleanup ()
 
void startFile (const QCString &name, const QCString &manName, const QCString &title, int)
 
void writeSearchInfo ()
 
void writeFooter (const QCString &)
 
void endFile ()
 
void clearBuffer ()
 
void startIndexSection (IndexSections)
 
void endIndexSection (IndexSections)
 
void writePageLink (const QCString &, bool)
 
void startProjectNumber ()
 
void endProjectNumber ()
 
void writeStyleInfo (int)
 
void startTitleHead (const QCString &)
 
void endTitleHead (const QCString &, const QCString &)
 
void startTitle ()
 
void endTitle ()
 
void newParagraph ()
 
void startParagraph (const QCString &classDef)
 
void endParagraph ()
 
void writeString (const QCString &text)
 
void startIndexListItem ()
 
void endIndexListItem ()
 
void startIndexList ()
 
void endIndexList ()
 
void startIndexKey ()
 
void endIndexKey ()
 
void startIndexValue (bool)
 
void endIndexValue (const QCString &, bool)
 
void startItemList ()
 
void endItemList ()
 
void startIndexItem (const QCString &ref, const QCString &file)
 
void endIndexItem (const QCString &ref, const QCString &file)
 
void docify (const QCString &text)
 
void codify (const QCString &text)
 
void writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)
 
void writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)
 
void writeTooltip (const QCString &, const DocLinkInfo &, const QCString &, const QCString &, const SourceLinkInfo &, const SourceLinkInfo &)
 
void startTextLink (const QCString &, const QCString &)
 
void endTextLink ()
 
void startHtmlLink (const QCString &url)
 
void endHtmlLink ()
 
void startTypewriter ()
 
void endTypewriter ()
 
void startGroupHeader (int)
 
void endGroupHeader (int)
 
void startMemberSections ()
 
void endMemberSections ()
 
void startHeaderSection ()
 
void endHeaderSection ()
 
void startMemberHeader (const QCString &, 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 QCString &, int, const QCString &)
 
void endMemberItem ()
 
void startMemberTemplateParams ()
 
void endMemberTemplateParams (const QCString &, const QCString &)
 
void startCompoundTemplateParams ()
 
void endCompoundTemplateParams ()
 
void startMemberGroupHeader (bool)
 
void endMemberGroupHeader ()
 
void startMemberGroupDocs ()
 
void endMemberGroupDocs ()
 
void startMemberGroup ()
 
void endMemberGroup (bool)
 
void writeRuler ()
 
void writeAnchor (const QCString &, const QCString &)
 
void startCodeFragment (const QCString &)
 
void endCodeFragment (const QCString &)
 
void writeLineNumber (const QCString &, const QCString &, const QCString &, 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 QCString &)
 
void writeChar (char c)
 
void startMemberDoc (const QCString &, const QCString &, const QCString &, const QCString &, int, int, bool)
 
void endMemberDoc (bool)
 
void startDoxyAnchor (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &)
 
void endDoxyAnchor (const QCString &, const QCString &)
 
void writeLatexSpacing ()
 
void writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &name)
 
void writeEndAnnoItem (const QCString &)
 
void startSubsection ()
 
void endSubsection ()
 
void startSubsubsection ()
 
void endSubsubsection ()
 
void startCenter ()
 
void endCenter ()
 
void startSmall ()
 
void endSmall ()
 
void startMemberDescription (const QCString &, const QCString &, bool)
 
void endMemberDescription ()
 
void startMemberDeclaration ()
 
void endMemberDeclaration (const QCString &, const QCString &)
 
void writeInheritedSectionTitle (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &, const QCString &)
 
void startDescList (SectionTypes)
 
void endDescList ()
 
void startExamples ()
 
void endExamples ()
 
void startParamList (ParamListTypes, const QCString &title)
 
void endParamList ()
 
void startDescForItem ()
 
void endDescForItem ()
 
void startSection (const QCString &, const QCString &, SectionType)
 
void endSection (const QCString &, SectionType)
 
void addIndexItem (const QCString &, const QCString &)
 
void startIndent ()
 
void endIndent ()
 
void writeSynopsis ()
 
void startClassDiagram ()
 
void endClassDiagram (const ClassDiagram &, const QCString &, const QCString &)
 
void startPageRef ()
 
void endPageRef (const QCString &, const QCString &)
 
void startQuickIndices ()
 
void endQuickIndices ()
 
void writeSplitBar (const QCString &)
 
void writeNavigationPath (const QCString &)
 
void writeLogo ()
 
void writeQuickLinks (bool, HighlightedItem, const QCString &)
 
void writeSummaryLink (const QCString &, const QCString &, const QCString &, bool)
 
void startContents ()
 
void endContents ()
 
void writeNonBreakableSpace (int n)
 
void startDescTable (const QCString &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 QCString &)
 
void endParameterType ()
 
void startParameterName (bool)
 
void endParameterName (bool, bool, bool)
 
void startParameterList (bool)
 
void endParameterList ()
 
void exceptionEntry (const QCString &, bool)
 
void startFontClass (const QCString &)
 
void endFontClass ()
 
void startConstraintList (const QCString &)
 
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 QCString &l, bool isLast)
 
void endLabels ()
 
void writeCodeAnchor (const QCString &)
 
void setCurrentDoc (const Definition *, const QCString &, bool)
 
void addWord (const QCString &, bool)
 
- Public Member Functions inherited from OutputGenerator
 OutputGenerator (const QCString &dir)
 
 OutputGenerator (const OutputGenerator &o)
 
OutputGeneratoroperator= (const OutputGenerator &o)
 
void enable ()
 
void disable ()
 
void enableIf (OutputType o)
 
void disableIf (OutputType o)
 
void disableIfNot (OutputType o)
 
bool isEnabled (OutputType o)
 
OutputGeneratorget (OutputType o)
 
QCString dir () const
 
QCString fileName () const
 
void startPlainFile (const QCString &name)
 
void endPlainFile ()
 
bool isEnabled () const
 
void pushGeneratorState ()
 
void popGeneratorState ()
 
virtual void startPageDoc (const QCString &)
 
virtual void endPageDoc ()
 
- Public Member Functions inherited from BaseOutputDocInterface
virtual void parseText (const QCString &)
 
- Public Member Functions inherited from CodeOutputInterface
 CodeOutputInterface (const CodeOutputInterface &)=delete
 
CodeOutputInterfaceoperator= (const CodeOutputInterface &)=delete
 
virtual int id () const
 Identifier for the output file.
 

Static Public Member Functions

static void init ()
 

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
TextStream m_t
 

Detailed Description

Generator for Man page output.

Member Function Documentation

◆ codify()

void ManGenerator::codify ( const QCString 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.

◆ docify()

void ManGenerator::docify ( const QCString s)
virtual

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

Implements BaseOutputDocInterface.

◆ endBold()

void ManGenerator::endBold ( )
inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

◆ endCodeFragment()

void ManGenerator::endCodeFragment ( const QCString style)
virtual

Ends a block of code

Implements CodeOutputInterface.

◆ endCodeLine()

void ManGenerator::endCodeLine ( )
inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

◆ endDescItem()

void ManGenerator::endDescItem ( )
virtual

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

Implements BaseOutputDocInterface.

◆ endDescription()

void ManGenerator::endDescription ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

◆ endEmphasis()

void ManGenerator::endEmphasis ( )
inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

◆ endFontClass()

void ManGenerator::endFontClass ( )
inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

◆ endHtmlLink()

void ManGenerator::endHtmlLink ( )
virtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

◆ endItemList()

void ManGenerator::endItemList ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

◆ endItemListItem()

void ManGenerator::endItemListItem ( )
virtual

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

Implements BaseOutputDocInterface.

◆ endParagraph()

void ManGenerator::endParagraph ( )
virtual

Ends a paragraph

Implements BaseOutputDocInterface.

◆ endTypewriter()

void ManGenerator::endTypewriter ( )
inlinevirtual

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

◆ startBold()

void ManGenerator::startBold ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

◆ startCodeFragment()

void ManGenerator::startCodeFragment ( const QCString style)
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()

Parameters
styleThe kind of code fragment.

Implements CodeOutputInterface.

◆ startDescItem()

void ManGenerator::startDescItem ( )
virtual

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

Implements BaseOutputDocInterface.

◆ startDescription()

void ManGenerator::startDescription ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

◆ startEmphasis()

void ManGenerator::startEmphasis ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

◆ startFontClass()

void ManGenerator::startFontClass ( const QCString 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.

◆ startHtmlLink()

void ManGenerator::startHtmlLink ( const QCString url)
virtual

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

Parameters
urlThe URL to link to.

Implements BaseOutputDocInterface.

◆ startItemList()

void ManGenerator::startItemList ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

◆ startItemListItem()

void ManGenerator::startItemListItem ( )
virtual

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

Implements BaseOutputDocInterface.

◆ startParagraph()

void ManGenerator::startParagraph ( const QCString classDef)
virtual

Starts a new paragraph

Starts a new paragraph

Implements BaseOutputDocInterface.

◆ startTypewriter()

void ManGenerator::startTypewriter ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

◆ writeChar()

void ManGenerator::writeChar ( char  c)
virtual

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

Implements BaseOutputDocInterface.

◆ writeCodeAnchor()

void ManGenerator::writeCodeAnchor ( const QCString name)
inlinevirtual

Write an anchor to a source listing.

Parameters
nameThe name of the anchor.

Implements CodeOutputInterface.

◆ writeCodeLink()

void ManGenerator::writeCodeLink ( CodeSymbolType  type,
const QCString ref,
const QCString file,
const QCString anchor,
const QCString name,
const QCString tooltip 
)
virtual

Writes a link to an object in a code fragment.

Parameters
typeThe type of symbol, used for semantic syntax highlighting, may be Default is no info is available.
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.

◆ writeLineNumber()

void ManGenerator::writeLineNumber ( const QCString ref,
const QCString file,
const QCString 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.

◆ writeObjectLink()

void ManGenerator::writeObjectLink ( const QCString ref,
const QCString file,
const QCString anchor,
const QCString 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.

◆ writeRuler()

void ManGenerator::writeRuler ( )
inlinevirtual

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

◆ writeString()

void ManGenerator::writeString ( const QCString text)
virtual

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

Implements BaseOutputDocInterface.

◆ writeTooltip()

void ManGenerator::writeTooltip ( const QCString id,
const DocLinkInfo docInfo,
const QCString decl,
const QCString 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.


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