Generator for Man page output. More...

#include <mangen.h>

Inheritance diagram for ManGenerator:

Public Member Functions
void	enable ()

void	disable ()

void	enableIf (OutputType o)

void	disableIf (OutputType o)

void	disableIfNot (OutputType o)

bool	isEnabled (OutputType o)

OutputGenerator *	get (OutputType o)

void	writeDoc (DocNode , Definition , 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 *)

void	endMemberHeader ()

void	insertMemberAlign (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 )

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	startSimpleSect (SectionTypes, const char , const char , const char *)

void	endSimpleSect ()

void	startParamList (ParamListTypes, const char *title)

void	endParamList ()

void	startDescForItem ()

void	endDescForItem ()

void	startSection (const char , const char , SectionInfo::SectionType)

void	endSection (const char *, SectionInfo::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 (const DotClassGraph &)

void	startInclDepGraph ()

void	endInclDepGraph (const DotInclDepGraph &)

void	startGroupCollaboration ()

void	endGroupCollaboration (const DotGroupCollaboration &)

void	startCallGraph ()

void	endCallGraph (const DotCallGraph &)

void	startDirDepGraph ()

void	endDirDepGraph (const DotDirDeps &)

void	writeGraphicalHierarchy (const 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 (Definition , const char , bool)

void	addWord (const char *, bool)

Public Member Functions inherited from OutputGenerator
void	startPlainFile (const char *name)

void	endPlainFile ()

bool	isEnabled () const

void	pushGeneratorState ()

void	popGeneratorState ()

Public Member Functions inherited from BaseOutputDocInterface
virtual bool	parseText (const QCString &s)

Static Public Member Functions
static void	init ()

Additional Inherited Members
Public Types inherited from OutputGenerator
enum	OutputType { Html, Latex, Man, RTF, XML, DEF, Perl }

Public Types inherited from BaseOutputDocInterface
enum	ParamListTypes { Param, RetVal, Exception }

enum	SectionTypes { EnumValues, Examples }

Protected Attributes inherited from OutputGenerator
FTextStream	t

QFile *	file

QCString	fileName

QCString	dir

bool	active

QStack< bool > *	genStack

Detailed Description

Generator for Man page output.

Member Function Documentation

§ 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.

§ 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.

§ endBold()

void ManGenerator::endBold ( )

inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

§ endCodeFragment()

void ManGenerator::endCodeFragment ( )

virtual

Ends a source code fragment

Implements BaseOutputDocInterface.

§ 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 ( )

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.

§ 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 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

clsName The category name.

Implements CodeOutputInterface.

§ startHtmlLink()

void ManGenerator::startHtmlLink ( const char * url )

virtual

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

Parameters

url	The 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 char * classDef )

virtual

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 char * name )

inlinevirtual

Write an anchor to a source listing.

Parameters

name	The name of the anchor.

Implements CodeOutputInterface.

§ 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

ref	If this is non-zero, the object is to be found in an external documentation file.
file	The file in which the object is located.
anchor	The anchor uniquely identifying the object within the file.
name	The text to display as a placeholder for the link.
tooltip	The tooltip to display when the mouse is on the link.

Implements CodeOutputInterface.

§ 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

ref	External reference (when imported from a tag file)
file	The file part of the URL pointing to the docs.
anchor	The anchor part of the URL pointing to the docs.
lineNumber	The line number to write

Implements CodeOutputInterface.

§ 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

ref	If this is non-zero, the object is to be found in an external documentation file.
file	The file in which the object is located.
anchor	The anchor uniquely identifying the object within the file.
name	The 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 char * text )

virtual

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

Implements BaseOutputDocInterface.

§ 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

id	unique identifier for the tooltip
docInfo	Info about the symbol's documentation.
decl	full declaration of the symbol (for functions)
desc	brief description for the symbol
defInfo	Info about the symbol's definition in the source code
declInfo	Info about the symbol's declaration in the source code

Implements CodeOutputInterface.

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

src/mangen.h
src/mangen.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

§ codify()

§ docify()

§ endBold()

§ endCodeFragment()

§ endCodeLine()

§ endDescItem()

§ endDescription()

§ endEmphasis()

§ endFontClass()

§ endHtmlLink()

§ endItemList()

§ endItemListItem()

§ endParagraph()

§ endTypewriter()

§ startBold()

§ startCodeFragment()

§ startDescItem()

§ startDescription()

§ startEmphasis()

§ startFontClass()

§ startHtmlLink()

§ startItemList()

§ startItemListItem()

§ startParagraph()

§ startTypewriter()

§ writeChar()

§ writeCodeAnchor()

§ writeCodeLink()

§ writeLineNumber()

§ writeObjectLink()

§ writeRuler()

§ writeString()

§ writeTooltip()