OutputList Class Reference

Class representing a list of output generators that are written to in parallel. More...

#include <outputlist.h>

Inheritance diagram for OutputList:

Collaboration diagram for OutputList:

Public Member Functions
	OutputList (const OutputList &ol)
OutputList &	operator= (const OutputList &ol)
template<class Generator >
void	add ()
size_t	size () const
int	id () const
	Identifier for the output file.
void	disableAllBut (OutputGenerator::OutputType o)
void	enableAll ()
void	disableAll ()
void	disable (OutputGenerator::OutputType o)
void	enable (OutputGenerator::OutputType o)
bool	isEnabled (OutputGenerator::OutputType o)
void	pushGeneratorState ()
void	popGeneratorState ()
void	generateDoc (const char *fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &docStr, bool indexWords, bool isExample, const char *exampleName, bool singleLine, bool linkFromIndex, bool markdownSupport)
void	writeDoc (DocRoot *root, const Definition *ctx, const MemberDef *md, int id=0)
void	parseText (const QCString &textStr)
void	startIndexSection (IndexSections is)
void	endIndexSection (IndexSections is)
void	writePageLink (const char *name, bool first)
void	startProjectNumber ()
void	endProjectNumber ()
void	writeStyleInfo (int part)
void	startFile (const char *name, const char *manName, const char *title)
void	writeSearchInfo ()
void	writeFooter (const char *navPath)
void	endFile ()
void	startTitleHead (const char *fileName)
void	endTitleHead (const char *fileName, const char *name)
void	startTitle ()
void	endTitle ()
void	startParagraph (const char *classDef=0)
void	endParagraph ()
void	writeString (const char *text)
void	startIndexListItem ()
void	endIndexListItem ()
void	startIndexList ()
void	endIndexList ()
void	startIndexKey ()
void	endIndexKey ()
void	startIndexValue (bool b)
void	endIndexValue (const char *name, bool b)
void	startItemList ()
void	endItemList ()
void	startIndexItem (const char *ref, const char *file)
void	endIndexItem (const char *ref, const char *file)
void	docify (const char *s)
void	codify (const char *s)
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 *id, const DocLinkInfo &docInfo, const char *decl, const char *desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
void	startTextLink (const char *file, const char *anchor)
void	endTextLink ()
void	startHtmlLink (const char *url)
void	endHtmlLink ()
void	writeStartAnnoItem (const char *type, const char *file, const char *path, const char *name)
void	writeEndAnnoItem (const char *name)
void	startTypewriter ()
void	endTypewriter ()
void	startGroupHeader (int extraLevels=0)
void	endGroupHeader (int extraLevels=0)
void	startItemListItem ()
void	endItemListItem ()
void	startMemberSections ()
void	endMemberSections ()
void	startHeaderSection ()
void	endHeaderSection ()
void	startMemberHeader (const char *anchor, int typ=2)
void	endMemberHeader ()
void	startMemberSubtitle ()
void	endMemberSubtitle ()
void	startMemberDocList ()
void	endMemberDocList ()
void	startMemberList ()
void	endMemberList ()
void	startInlineHeader ()
void	endInlineHeader ()
void	startAnonTypeScope (int i1)
void	endAnonTypeScope (int i1)
void	startMemberItem (const char *anchor, int i1, const char *id=0)
void	endMemberItem ()
void	startMemberTemplateParams ()
void	endMemberTemplateParams (const char *anchor, const char *inheritId)
void	startMemberGroupHeader (bool b)
void	endMemberGroupHeader ()
void	startMemberGroupDocs ()
void	endMemberGroupDocs ()
void	startMemberGroup ()
void	endMemberGroup (bool last)
void	insertMemberAlign (bool templ=FALSE)
void	insertMemberAlignLeft (int typ=0, bool templ=FALSE)
void	writeRuler ()
void	writeAnchor (const char *fileName, const char *name)
void	startCodeFragment (const char *style)
void	endCodeFragment (const char *style)
void	startCodeLine (bool hasLineNumbers)
void	endCodeLine ()
void	writeLineNumber (const char *ref, const char *file, const char *anchor, int lineNumber)
void	startEmphasis ()
void	endEmphasis ()
void	writeChar (char c)
void	startMemberDoc (const char *clName, const char *memName, const char *anchor, const char *title, int memCount, int memTotal, bool showInline)
void	endMemberDoc (bool hasArgs)
void	startDoxyAnchor (const char *fName, const char *manName, const char *anchor, const char *name, const char *args)
void	endDoxyAnchor (const char *fn, const char *anchor)
void	writeLatexSpacing ()
void	startDescription ()
void	endDescription ()
void	startDescItem ()
void	endDescItem ()
void	startDescForItem ()
void	endDescForItem ()
void	startSubsection ()
void	endSubsection ()
void	startSubsubsection ()
void	endSubsubsection ()
void	startCenter ()
void	endCenter ()
void	startSmall ()
void	endSmall ()
void	lineBreak (const char *style=0)
void	startBold ()
void	endBold ()
void	startMemberDescription (const char *anchor, const char *inheritId=0, bool typ=false)
void	endMemberDescription ()
void	startMemberDeclaration ()
void	endMemberDeclaration (const char *anchor, const char *inheritId)
void	writeInheritedSectionTitle (const char *id, const char *ref, const char *file, const char *anchor, const char *title, const char *name)
void	startExamples ()
void	endExamples ()
void	startParamList (ParamListTypes t, const char *title)
void	endParamList ()
void	startIndent ()
void	endIndent ()
void	startSection (const char *lab, const char *title, SectionType t)
void	endSection (const char *lab, SectionType t)
void	addIndexItem (const char *s1, const char *s2)
void	writeSynopsis ()
void	startClassDiagram ()
void	endClassDiagram (const ClassDiagram &d, const char *f, const char *n)
void	startPageRef ()
void	endPageRef (const char *c, const char *a)
void	startQuickIndices ()
void	endQuickIndices ()
void	writeSplitBar (const char *name)
void	writeNavigationPath (const char *s)
void	writeLogo ()
void	writeQuickLinks (bool compact, HighlightedItem hli, const char *file)
void	writeSummaryLink (const char *file, const char *anchor, const char *title, bool first)
void	startContents ()
void	endContents ()
void	startPageDoc (const char *pageTitle)
void	endPageDoc ()
void	writeNonBreakableSpace (int num)
void	startDescTable (const char *title)
void	endDescTable ()
void	startDescTableRow ()
void	endDescTableRow ()
void	startDescTableTitle ()
void	endDescTableTitle ()
void	startDescTableData ()
void	endDescTableData ()
void	startDotGraph ()
void	endDotGraph (DotClassGraph &g)
void	startInclDepGraph ()
void	endInclDepGraph (DotInclDepGraph &g)
void	startCallGraph ()
void	endCallGraph (DotCallGraph &g)
void	startDirDepGraph ()
void	endDirDepGraph (DotDirDeps &g)
void	startGroupCollaboration ()
void	endGroupCollaboration (DotGroupCollaboration &g)
void	writeGraphicalHierarchy (DotGfxHierarchyTable &g)
void	startTextBlock (bool dense=FALSE)
void	endTextBlock (bool paraBreak=FALSE)
void	lastIndexPage ()
void	startMemberDocPrefixItem ()
void	endMemberDocPrefixItem ()
void	startMemberDocName (bool align)
void	endMemberDocName ()
void	startParameterType (bool first, const char *key)
void	endParameterType ()
void	startParameterName (bool one)
void	endParameterName (bool last, bool one, bool bracket)
void	startParameterList (bool openBracket)
void	endParameterList ()
void	exceptionEntry (const char *prefix, bool closeBracket)
void	startConstraintList (const char *header)
void	startConstraintParam ()
void	endConstraintParam ()
void	startConstraintType ()
void	endConstraintType ()
void	startConstraintDocs ()
void	endConstraintDocs ()
void	endConstraintList ()
void	startMemberDocSimple (bool b)
void	endMemberDocSimple (bool b)
void	startInlineMemberType ()
void	endInlineMemberType ()
void	startInlineMemberName ()
void	endInlineMemberName ()
void	startInlineMemberDoc ()
void	endInlineMemberDoc ()
void	startLabels ()
void	writeLabel (const char *l, bool isLast)
void	endLabels ()
void	startFontClass (const char *c)
void	endFontClass ()
void	writeCodeAnchor (const char *name)
void	setCurrentDoc (const Definition *context, const char *anchor, bool isSourceFile)
void	addWord (const char *word, bool hiPriority)
void	startPlainFile (const char *name)
void	endPlainFile ()

Additional Inherited Members
Public Types inherited from BaseOutputDocInterface
enum	ParamListTypes { Param, RetVal, Exception }
enum	SectionTypes { EnumValues, Examples }

Detailed Description

Class representing a list of output generators that are written to in parallel.

Member Function Documentation

codify()

void OutputList::codify ( const char *  s )

inlinevirtual

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.

disable()

void OutputList::disable ( OutputGenerator::OutputType  o )

virtual

Disables a specific output format (useful for OutputList only)

Implements OutputDocInterface.

disableAll()

void OutputList::disableAll ( )

virtual

Disables all output formats (useful for OutputList only)

Implements OutputDocInterface.

disableAllBut()

void OutputList::disableAllBut ( OutputGenerator::OutputType  o )

virtual

Disables all output formats except format o (useful for OutputList only)

Implements OutputDocInterface.

docify()

void OutputList::docify ( const char *  s )

inlinevirtual

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

Implements BaseOutputDocInterface.

enable()

void OutputList::enable ( OutputGenerator::OutputType  o )

virtual

Enables a specific output format (useful for OutputList only)

Implements OutputDocInterface.

enableAll()

void OutputList::enableAll ( )

virtual

Enables all output formats as far as they have been enabled in the config file. (useful for OutputList only)

Implements OutputDocInterface.

endBold()

void OutputList::endBold ( )

inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

endCodeFragment()

void OutputList::endCodeFragment ( const char *  style )

inlinevirtual

Ends a block of code

Implements CodeOutputInterface.

endCodeLine()

void OutputList::endCodeLine ( )

inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

endDescItem()

void OutputList::endDescItem ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

endDescription()

void OutputList::endDescription ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

endEmphasis()

void OutputList::endEmphasis ( )

inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

endFontClass()

void OutputList::endFontClass ( )

inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

endHtmlLink()

void OutputList::endHtmlLink ( )

inlinevirtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

endItemList()

void OutputList::endItemList ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

endItemListItem()

void OutputList::endItemListItem ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

endParagraph()

void OutputList::endParagraph ( )

inlinevirtual

Ends a paragraph

Implements BaseOutputDocInterface.

endTypewriter()

void OutputList::endTypewriter ( )

inlinevirtual

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

isEnabled()

bool OutputList::isEnabled ( OutputGenerator::OutputType  o )

virtual

Check whether a specific output format is currently enabled (useful for OutputList only)

Implements OutputDocInterface.

popGeneratorState()

void OutputList::popGeneratorState ( )

virtual

Pops the state of the current generator (or list of generators) on a stack. Should be preceded by a call the pushGeneratorState().

Implements OutputDocInterface.

pushGeneratorState()

void OutputList::pushGeneratorState ( )

virtual

Appends the output generated by generator g to this generator.

Pushes the state of the current generator (or list of generators) on a stack.

Implements OutputDocInterface.

startBold()

void OutputList::startBold ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

startCodeFragment()

void OutputList::startCodeFragment ( const char *  style )

inlinevirtual

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

style

The kind of code fragment.

Implements CodeOutputInterface.

startDescItem()

void OutputList::startDescItem ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

startDescription()

void OutputList::startDescription ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

startEmphasis()

void OutputList::startEmphasis ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

startFontClass()

void OutputList::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 OutputList::startHtmlLink ( const char *  url )

inlinevirtual

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

Parameters

url	The URL to link to.

Implements BaseOutputDocInterface.

startItemList()

void OutputList::startItemList ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

startItemListItem()

void OutputList::startItemListItem ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

startParagraph()

void OutputList::startParagraph ( const char *  classDef = 0 )

inlinevirtual

Starts a new paragraph

Starts a new paragraph

Implements BaseOutputDocInterface.

startTypewriter()

void OutputList::startTypewriter ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

writeChar()

void OutputList::writeChar ( char  c )

inlinevirtual

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

Implements BaseOutputDocInterface.

writeCodeAnchor()

void OutputList::writeCodeAnchor ( const char *  name )

inlinevirtual

Write an anchor to a source listing.

Parameters

name	The name of the anchor.

Implements CodeOutputInterface.

writeCodeLink()

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

inlinevirtual

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 OutputList::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 OutputList::writeObjectLink ( const char *  ref, const char *  file, const char *  anchor, const char *  name  )

inlinevirtual

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 OutputList::writeRuler ( )

inlinevirtual

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

writeString()

void OutputList::writeString ( const char *  text )

inlinevirtual

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

Implements BaseOutputDocInterface.

writeTooltip()

void OutputList::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/outputlist.h
• src/outputlist.cpp