OutputList Class Reference

#include <outputlist.h>

Inheritance diagram for OutputList:

Public Member Functions
	OutputList (bool)
virtual	~OutputList ()
void	add (const OutputGenerator *)
uint	count () const
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 ()
bool	generateDoc (const char *fileName, int startLine, Definition *ctx, MemberDef *md, const QCString &docStr, bool indexWords, bool isExample, const char *exampleName=0, bool singleLine=FALSE, bool linkFromIndex=FALSE)
void	writeDoc (DocRoot *root, Definition *ctx, MemberDef *md)
bool	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 ()
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)
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	writeRuler ()
void	writeAnchor (const char *fileName, const char *name)
void	startCodeFragment ()
void	endCodeFragment ()
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, 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)
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	startSimpleSect (SectionTypes t, const char *file, const char *anchor, const char *title)
void	endSimpleSect ()
void	startParamList (ParamListTypes t, const char *title)
void	endParamList ()
void	startIndent ()
void	endIndent ()
void	startSection (const char *lab, const char *title, SectionInfo::SectionType t)
void	endSection (const char *lab, SectionInfo::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	writeNonBreakableSpace (int num)
void	startDescTable (const char *title)
void	endDescTable ()
void	startDescTableTitle ()
void	endDescTableTitle ()
void	startDescTableData ()
void	endDescTableData ()
void	startDotGraph ()
void	endDotGraph (const DotClassGraph &g)
void	startInclDepGraph ()
void	endInclDepGraph (const DotInclDepGraph &g)
void	startCallGraph ()
void	endCallGraph (const DotCallGraph &g)
void	startDirDepGraph ()
void	endDirDepGraph (const DotDirDeps &g)
void	startGroupCollaboration ()
void	endGroupCollaboration (const DotGroupCollaboration &g)
void	writeGraphicalHierarchy (const 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 ()
void	endMemberDocSimple ()
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 (Definition *context, const char *anchor, bool isSourceFile)
void	addWord (const char *word, bool hiPriority)
void	startPlainFile (const char *name)
void	endPlainFile ()
Public Member Functions inherited from OutputDocInterface
virtual	~OutputDocInterface ()
Public Member Functions inherited from BaseOutputDocInterface
virtual	~BaseOutputDocInterface ()
Public Member Functions inherited from CodeOutputInterface
virtual	~CodeOutputInterface ()

Private Member Functions
void	debug ()
void	clear ()
void	forall (void(OutputGenerator::*func)())
	FORALLPROTO1 (const char *)
	FORALLPROTO1 (char)
	FORALLPROTO1 (IndexSections)
	FORALLPROTO1 (int)
	FORALLPROTO1 (const DotClassGraph &)
	FORALLPROTO1 (const DotInclDepGraph &)
	FORALLPROTO1 (const DotCallGraph &)
	FORALLPROTO1 (const DotGroupCollaboration &)
	FORALLPROTO1 (const DotDirDeps &)
	FORALLPROTO1 (const DotGfxHierarchyTable &)
	FORALLPROTO1 (SectionTypes)
	FORALLPROTO2 (int, bool)
	FORALLPROTO2 (bool, const char *)
	FORALLPROTO2 (ParamListTypes, const char *)
	FORALLPROTO2 (const char *, const char *)
	FORALLPROTO2 (const char *, int)
	FORALLPROTO2 (const char *, SectionInfo::SectionType)
	FORALLPROTO3 (bool, HighlightedItem, const char *)
	FORALLPROTO3 (bool, bool, bool)
	FORALLPROTO3 (const char *, const char *, bool)
	FORALLPROTO3 (const char *, int, const char *)
	FORALLPROTO3 (const char *, const char *, SectionInfo::SectionType)
	FORALLPROTO3 (uchar, uchar, uchar)
	FORALLPROTO3 (const char *, const char *, const char *)
	FORALLPROTO3 (const ClassDiagram &, const char *, const char *)
	FORALLPROTO3 (Definition *, const char *, bool)
	FORALLPROTO4 (SectionTypes, const char *, const char *, const char *)
	FORALLPROTO4 (const char *, const char *, const char *, const char *)
	FORALLPROTO4 (const char *, const char *, const char *, bool)
	FORALLPROTO5 (const char *, const char *, const char *, const char *, const char *)
	FORALLPROTO5 (const char *, const char *, const char *, const char *, bool)
	FORALLPROTO6 (const char *, const char *, const char *, const char *, const char *, const char *)
	FORALLPROTO6 (const char *, const DocLinkInfo &, const char *, const char *, const SourceLinkInfo &, const SourceLinkInfo &)
	OutputList (const OutputList &ol)

Private Attributes
QList< OutputGenerator >	m_outputs

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.

Definition at line 54 of file outputlist.h.

Constructor & Destructor Documentation

OutputList::OutputList

(

bool

)

Definition at line 33 of file outputlist.cpp.

{
  //printf("OutputList::OutputList()\n");
  m_outputs.setAutoDelete(TRUE);
}

OutputList::~OutputList ( )

virtual

Definition at line 39 of file outputlist.cpp.

{
  //printf("OutputList::~OutputList()\n");
}

OutputList::OutputList ( const OutputList &  ol )

private

Member Function Documentation

void OutputList::add

(

const OutputGenerator *

og

)

Definition at line 44 of file outputlist.cpp.

{
  if (og) m_outputs.append(og);
}

void OutputList::addIndexItem ( const char *  s1, const char *  s2  )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 338 of file outputlist.h.

    { forall(&OutputGenerator::addIndexItem,s1,s2); }

void OutputList::addWord ( const char *  word, bool  hiPriority  )

inlinevirtual

Implements CodeOutputInterface.

Definition at line 482 of file outputlist.h.

    { forall(&OutputGenerator::addWord,word,hiPriority); }

void OutputList::clear ( )

private

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.

Definition at line 147 of file outputlist.h.

    { forall(&OutputGenerator::codify,s); }

uint OutputList::count ( ) const

inline

Definition at line 61 of file outputlist.h.

{ return m_outputs.count(); }

void OutputList::debug ( )

private

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

virtual

Disables a specific output format (useful for OutputList only)

Implements OutputDocInterface.

Definition at line 79 of file outputlist.cpp.

{
  QListIterator<OutputGenerator> it(m_outputs);
  OutputGenerator *og;
  for (it.toFirst();(og=it.current());++it)
  {
    og->disableIf(o);
  }
}

void OutputList::disableAll ( )

virtual

Disables all output formats (useful for OutputList only)

Implements OutputDocInterface.

Definition at line 69 of file outputlist.cpp.

{
  QListIterator<OutputGenerator> it(m_outputs);
  OutputGenerator *og;
  for (it.toFirst();(og=it.current());++it)
  {
    og->disable();
  }
}

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

virtual

Create a new output generator. This can later by appended to the current one using append().

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

Implements OutputDocInterface.

Definition at line 49 of file outputlist.cpp.

{
  QListIterator<OutputGenerator> it(m_outputs);
  OutputGenerator *og;
  for (it.toFirst();(og=it.current());++it)
  {
    og->disableIfNot(o);
  }
}

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.

Definition at line 145 of file outputlist.h.

    { forall(&OutputGenerator::docify,s); }

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

virtual

Enables a specific output format (useful for OutputList only)

Implements OutputDocInterface.

Definition at line 89 of file outputlist.cpp.

{
  QListIterator<OutputGenerator> it(m_outputs);
  OutputGenerator *og;
  for (it.toFirst();(og=it.current());++it)
  {
    og->enableIf(o);
  }
}

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.

Definition at line 59 of file outputlist.cpp.

{
  QListIterator<OutputGenerator> it(m_outputs);
  OutputGenerator *og;
  for (it.toFirst();(og=it.current());++it)
  {
    og->enable();
  }
}

void OutputList::endAnonTypeScope ( int  i1 )

inline

Definition at line 216 of file outputlist.h.

    { forall(&OutputGenerator::endAnonTypeScope,i1); }

void OutputList::endBold ( )

inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

Definition at line 306 of file outputlist.h.

    { forall(&OutputGenerator::endBold); }

void OutputList::endCallGraph ( const DotCallGraph &  g )

inline

Definition at line 392 of file outputlist.h.

    { forall(&OutputGenerator::endCallGraph,g); }

void OutputList::endCenter ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 296 of file outputlist.h.

    { forall(&OutputGenerator::endCenter); }

void OutputList::endClassDiagram ( const ClassDiagram &  d, const char *  f, const char *  n  )

inline

Definition at line 344 of file outputlist.h.

    { forall(&OutputGenerator::endClassDiagram,d,f,n); }

void OutputList::endCodeFragment ( )

inlinevirtual

Ends a source code fragment

Implements BaseOutputDocInterface.

Definition at line 246 of file outputlist.h.

    { forall(&OutputGenerator::endCodeFragment); }

void OutputList::endCodeLine ( )

inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

Definition at line 250 of file outputlist.h.

    { forall(&OutputGenerator::endCodeLine); }

void OutputList::endConstraintDocs ( )

inline

Definition at line 445 of file outputlist.h.

    { forall(&OutputGenerator::endConstraintDocs); }

void OutputList::endConstraintList ( )

inline

Definition at line 447 of file outputlist.h.

    { forall(&OutputGenerator::endConstraintList); }

void OutputList::endConstraintParam ( )

inline

Definition at line 437 of file outputlist.h.

    { forall(&OutputGenerator::endConstraintParam); }

void OutputList::endConstraintType ( )

inline

Definition at line 441 of file outputlist.h.

    { forall(&OutputGenerator::endConstraintType); }

void OutputList::endContents ( )

inline

Definition at line 366 of file outputlist.h.

    { forall(&OutputGenerator::endContents); }

void OutputList::endDescForItem ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 284 of file outputlist.h.

    { forall(&OutputGenerator::endDescForItem); }

void OutputList::endDescItem ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 280 of file outputlist.h.

    { forall(&OutputGenerator::endDescItem); }

void OutputList::endDescription ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 276 of file outputlist.h.

    { forall(&OutputGenerator::endDescription); }

void OutputList::endDescTable ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 372 of file outputlist.h.

    { forall(&OutputGenerator::endDescTable); }

void OutputList::endDescTableData ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 380 of file outputlist.h.

    { forall(&OutputGenerator::endDescTableData); }

void OutputList::endDescTableTitle ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 376 of file outputlist.h.

    { forall(&OutputGenerator::endDescTableTitle); }

void OutputList::endDirDepGraph ( const DotDirDeps &  g )

inline

Definition at line 396 of file outputlist.h.

    { forall(&OutputGenerator::endDirDepGraph,g); }

void OutputList::endDotGraph ( const DotClassGraph &  g )

inline

Definition at line 384 of file outputlist.h.

    { forall(&OutputGenerator::endDotGraph,g); }

void OutputList::endDoxyAnchor ( const char *  fn, const char *  anchor  )

inline

Definition at line 270 of file outputlist.h.

    { forall(&OutputGenerator::endDoxyAnchor,fn,anchor); }

void OutputList::endEmphasis ( )

inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 257 of file outputlist.h.

    { forall(&OutputGenerator::endEmphasis); }

void OutputList::endFile ( )

inline

Definition at line 103 of file outputlist.h.

    { forall(&OutputGenerator::endFile); }

void OutputList::endFontClass ( )

inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

Definition at line 476 of file outputlist.h.

    { forall(&OutputGenerator::endFontClass); }

void OutputList::endGroupCollaboration ( const DotGroupCollaboration &  g )

inline

Definition at line 400 of file outputlist.h.

    { forall(&OutputGenerator::endGroupCollaboration,g); }

void OutputList::endGroupHeader ( int  extraLevels = 0 )

inline

Definition at line 178 of file outputlist.h.

    { forall(&OutputGenerator::endGroupHeader,extraLevels); }

void OutputList::endHeaderSection ( )

inline

Definition at line 192 of file outputlist.h.

    { forall(&OutputGenerator::endHeaderSection); }

void OutputList::endHtmlLink ( )

inlinevirtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 165 of file outputlist.h.

    { forall(&OutputGenerator::endHtmlLink); }

void OutputList::endInclDepGraph ( const DotInclDepGraph &  g )

inline

Definition at line 388 of file outputlist.h.

    { forall(&OutputGenerator::endInclDepGraph,g); }

void OutputList::endIndent ( )

inline

Definition at line 332 of file outputlist.h.

    { forall(&OutputGenerator::endIndent); }

void OutputList::endIndexItem ( const char *  ref, const char *  file  )

inline

Definition at line 143 of file outputlist.h.

    { forall(&OutputGenerator::endIndexItem,ref,file); }

void OutputList::endIndexKey ( )

inline

Definition at line 131 of file outputlist.h.

    { forall(&OutputGenerator::endIndexKey); }

void OutputList::endIndexList ( )

inline

Definition at line 127 of file outputlist.h.

    { forall(&OutputGenerator::endIndexList); }

void OutputList::endIndexListItem ( )

inline

Definition at line 123 of file outputlist.h.

    { forall(&OutputGenerator::endIndexListItem); }

void OutputList::endIndexSection ( IndexSections  is )

inline

Definition at line 87 of file outputlist.h.

    { forall(&OutputGenerator::endIndexSection,is); }

void OutputList::endIndexValue ( const char *  name, bool  b  )

inline

Definition at line 135 of file outputlist.h.

    { forall(&OutputGenerator::endIndexValue,name,b); }

void OutputList::endInlineHeader ( )

inline

Definition at line 212 of file outputlist.h.

    { forall(&OutputGenerator::endInlineHeader); }

void OutputList::endInlineMemberDoc ( )

inline

Definition at line 464 of file outputlist.h.

    { forall(&OutputGenerator::endInlineMemberDoc); }

void OutputList::endInlineMemberName ( )

inline

Definition at line 460 of file outputlist.h.

    { forall(&OutputGenerator::endInlineMemberName); }

void OutputList::endInlineMemberType ( )

inline

Definition at line 456 of file outputlist.h.

    { forall(&OutputGenerator::endInlineMemberType); }

void OutputList::endItemList ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 139 of file outputlist.h.

    { forall(&OutputGenerator::endItemList); }

void OutputList::endItemListItem ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 184 of file outputlist.h.

    { forall(&OutputGenerator::endItemListItem); }

void OutputList::endLabels ( )

inline

Definition at line 471 of file outputlist.h.

    { forall(&OutputGenerator::endLabels); }

void OutputList::endMemberDeclaration ( const char *  anchor, const char *  inheritId  )

inline

Definition at line 314 of file outputlist.h.

    { forall(&OutputGenerator::endMemberDeclaration,anchor,inheritId); }

void OutputList::endMemberDescription ( )

inline

Definition at line 310 of file outputlist.h.

    { forall(&OutputGenerator::endMemberDescription); }

void OutputList::endMemberDoc ( bool  hasArgs )

inline

Definition at line 264 of file outputlist.h.

    { forall(&OutputGenerator::endMemberDoc,hasArgs); }

void OutputList::endMemberDocList ( )

inline

Definition at line 204 of file outputlist.h.

    { forall(&OutputGenerator::endMemberDocList); }

void OutputList::endMemberDocName ( )

inline

Definition at line 416 of file outputlist.h.

    { forall(&OutputGenerator::endMemberDocName); }

void OutputList::endMemberDocPrefixItem ( )

inline

Definition at line 412 of file outputlist.h.

    { forall(&OutputGenerator::endMemberDocPrefixItem); }

void OutputList::endMemberDocSimple ( )

inline

Definition at line 452 of file outputlist.h.

    { forall(&OutputGenerator::endMemberDocSimple); }

void OutputList::endMemberGroup ( bool  last )

inline

Definition at line 236 of file outputlist.h.

    { forall(&OutputGenerator::endMemberGroup,last); }

void OutputList::endMemberGroupDocs ( )

inline

Definition at line 232 of file outputlist.h.

    { forall(&OutputGenerator::endMemberGroupDocs); }

void OutputList::endMemberGroupHeader ( )

inline

Definition at line 228 of file outputlist.h.

    { forall(&OutputGenerator::endMemberGroupHeader); }

void OutputList::endMemberHeader ( )

inline

Definition at line 196 of file outputlist.h.

    { forall(&OutputGenerator::endMemberHeader); }

void OutputList::endMemberItem ( )

inline

Definition at line 220 of file outputlist.h.

    { forall(&OutputGenerator::endMemberItem); }

void OutputList::endMemberList ( )

inline

Definition at line 208 of file outputlist.h.

    { forall(&OutputGenerator::endMemberList); }

void OutputList::endMemberSections ( )

inline

Definition at line 188 of file outputlist.h.

    { forall(&OutputGenerator::endMemberSections); }

void OutputList::endMemberSubtitle ( )

inline

Definition at line 200 of file outputlist.h.

    { forall(&OutputGenerator::endMemberSubtitle); }

void OutputList::endMemberTemplateParams ( const char *  anchor, const char *  inheritId  )

inline

Definition at line 224 of file outputlist.h.

    { forall(&OutputGenerator::endMemberTemplateParams,anchor,inheritId); }

void OutputList::endPageRef ( const char *  c, const char *  a  )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 348 of file outputlist.h.

    { forall(&OutputGenerator::endPageRef,c,a); }

void OutputList::endParagraph ( )

inlinevirtual

Ends a paragraph

Implements BaseOutputDocInterface.

Definition at line 117 of file outputlist.h.

    { forall(&OutputGenerator::endParagraph); }

void OutputList::endParameterList ( )

inline

Definition at line 428 of file outputlist.h.

    { forall(&OutputGenerator::endParameterList); }

void OutputList::endParameterName ( bool  last, bool  one, bool  bracket  )

inline

Definition at line 424 of file outputlist.h.

    { forall(&OutputGenerator::endParameterName,last,one,bracket); }

void OutputList::endParameterType ( )

inline

Definition at line 420 of file outputlist.h.

    { forall(&OutputGenerator::endParameterType); }

void OutputList::endParamList ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 328 of file outputlist.h.

    { forall(&OutputGenerator::endParamList); }

void OutputList::endPlainFile ( )

inline

Definition at line 494 of file outputlist.h.

    {
      QListIterator<OutputGenerator> it(m_outputs);
      OutputGenerator *og;
      for (;(og=it.current());++it)
      {
        if (og->isEnabled()) (og->endPlainFile)();
      }
    }

void OutputList::endProjectNumber ( )

inline

Definition at line 93 of file outputlist.h.

    { forall(&OutputGenerator::endProjectNumber); }

void OutputList::endQuickIndices ( )

inline

Definition at line 352 of file outputlist.h.

    { forall(&OutputGenerator::endQuickIndices); }

void OutputList::endSection ( const char *  lab, SectionInfo::SectionType  t  )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 336 of file outputlist.h.

    { forall(&OutputGenerator::endSection,lab,t); }

void OutputList::endSimpleSect ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 324 of file outputlist.h.

    { forall(&OutputGenerator::endSimpleSect); }

void OutputList::endSmall ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 300 of file outputlist.h.

    { forall(&OutputGenerator::endSmall); }

void OutputList::endSubsection ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 288 of file outputlist.h.

    { forall(&OutputGenerator::endSubsection); }

void OutputList::endSubsubsection ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 292 of file outputlist.h.

    { forall(&OutputGenerator::endSubsubsection); }

void OutputList::endTextBlock ( bool  paraBreak = FALSE )

inline

Definition at line 406 of file outputlist.h.

    { forall(&OutputGenerator::endTextBlock,paraBreak); }

void OutputList::endTextLink ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 161 of file outputlist.h.

    { forall(&OutputGenerator::endTextLink); }

void OutputList::endTitle ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 111 of file outputlist.h.

    { forall(&OutputGenerator::endTitle); }

void OutputList::endTitleHead ( const char *  fileName, const char *  name  )

inline

Definition at line 107 of file outputlist.h.

    { forall(&OutputGenerator::endTitleHead,fileName,name); }

void OutputList::endTypewriter ( )

inlinevirtual

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

Definition at line 174 of file outputlist.h.

    { forall(&OutputGenerator::endTypewriter); }

void OutputList::exceptionEntry ( const char *  prefix, bool  closeBracket  )

inline

Definition at line 430 of file outputlist.h.

    { forall(&OutputGenerator::exceptionEntry,prefix,closeBracket); }

void OutputList::forall ( void(OutputGenerator::*)()  func )

private

Definition at line 207 of file outputlist.cpp.

{
  QListIterator<OutputGenerator> it(m_outputs);
  OutputGenerator *og;
  for (it.toFirst();(og=it.current());++it)
  {
    if (og->isEnabled()) (og->*func)();
  }
}

OutputList::FORALLPROTO1 ( const char *  )

private

OutputList::FORALLPROTO1 ( char  )

private

OutputList::FORALLPROTO1 ( IndexSections  )

private

OutputList::FORALLPROTO1 ( int  )

private

OutputList::FORALLPROTO1 ( const DotClassGraph &  )

private

OutputList::FORALLPROTO1 ( const DotInclDepGraph &  )

private

OutputList::FORALLPROTO1 ( const DotCallGraph &  )

private

OutputList::FORALLPROTO1 ( const DotGroupCollaboration &  )

private

OutputList::FORALLPROTO1 ( const DotDirDeps &  )

private

OutputList::FORALLPROTO1 ( const DotGfxHierarchyTable &  )

private

OutputList::FORALLPROTO1 ( SectionTypes  )

private

OutputList::FORALLPROTO2 ( int  , bool    )

private

OutputList::FORALLPROTO2 ( bool  , const char *    )

private

OutputList::FORALLPROTO2 ( ParamListTypes  , const char *    )

private

OutputList::FORALLPROTO2 ( const char *  , const char *    )

private

OutputList::FORALLPROTO2 ( const char *  , int    )

private

OutputList::FORALLPROTO2 ( const char *  , SectionInfo::SectionType    )

private

OutputList::FORALLPROTO3 ( bool  , HighlightedItem  , const char *    )

private

OutputList::FORALLPROTO3 ( bool  , bool  , bool    )

private

OutputList::FORALLPROTO3 ( const char *  , const char *  , bool    )

private

OutputList::FORALLPROTO3 ( const char *  , int  , const char *    )

private

OutputList::FORALLPROTO3 ( const char *  , const char *  , SectionInfo::SectionType    )

private

OutputList::FORALLPROTO3 ( uchar  , uchar  , uchar    )

private

OutputList::FORALLPROTO3 ( const char *  , const char *  , const char *    )

private

OutputList::FORALLPROTO3 ( const ClassDiagram &  , const char *  , const char *    )

private

OutputList::FORALLPROTO3 ( Definition *  , const char *  , bool    )

private

OutputList::FORALLPROTO4 ( SectionTypes  , const char *  , const char *  , const char *    )

private

OutputList::FORALLPROTO4 ( const char *  , const char *  , const char *  , const char *    )

private

OutputList::FORALLPROTO4 ( const char *  , const char *  , const char *  , bool    )

private

OutputList::FORALLPROTO5 ( const char *  , const char *  , const char *  , const char *  , const char *    )

private

OutputList::FORALLPROTO5 ( const char *  , const char *  , const char *  , const char *  , bool    )

private

OutputList::FORALLPROTO6 ( const char *  , const char *  , const char *  , const char *  , const char *  , const char *    )

private

OutputList::FORALLPROTO6 ( const char *  , const DocLinkInfo &  , const char *  , const char *  , const SourceLinkInfo &  , const SourceLinkInfo &    )

private

bool OutputList::generateDoc	(	const char *	fileName,
		int	startLine,
		Definition *	ctx,
		MemberDef *	md,
		const QCString &	docStr,
		bool	indexWords,
		bool	isExample,
		const char *	exampleName = 0,
		bool	singleLine = FALSE,
		bool	linkFromIndex = FALSE
	)

Definition at line 131 of file outputlist.cpp.

{
  int count=0;
  if (docStr.isEmpty()) return TRUE;

  QListIterator<OutputGenerator> it(m_outputs);
  OutputGenerator *og;
  for (it.toFirst();(og=it.current());++it)
  {
    if (og->isEnabled()) count++;
  }
  if (count==0) return TRUE; // no output formats enabled.

  DocRoot *root=0;
  root = validatingParseDoc(fileName,startLine,
                            ctx,md,docStr,indexWords,isExample,exampleName,
                            singleLine,linkFromIndex);

  writeDoc(root,ctx,md);

  bool isEmpty = root->isEmpty();

  delete root;

  return isEmpty;
}

void OutputList::insertMemberAlign ( bool  templ = FALSE )

inline

Definition at line 238 of file outputlist.h.

    { forall(&OutputGenerator::insertMemberAlign,templ); }

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

virtual

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

Implements OutputDocInterface.

Definition at line 99 of file outputlist.cpp.

{
  bool result=FALSE;
  QListIterator<OutputGenerator> it(m_outputs);
  OutputGenerator *og;
  for (it.toFirst();(og=it.current());++it)
  {
    result=result || og->isEnabled(o);
  }
  return result;
}

void OutputList::lastIndexPage ( )

inline

Definition at line 408 of file outputlist.h.

    { forall(&OutputGenerator::lastIndexPage); }

void OutputList::lineBreak ( const char *  style = 0 )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 302 of file outputlist.h.

    { forall(&OutputGenerator::lineBreak,style); }

bool OutputList::parseText ( const QCString &  textStr )

virtual

Reimplemented from BaseOutputDocInterface.

Definition at line 175 of file outputlist.cpp.

{
  int count=0;
  QListIterator<OutputGenerator> it(m_outputs);
  OutputGenerator *og;
  for (it.toFirst();(og=it.current());++it)
  {
    if (og->isEnabled()) count++;
  }
  if (count==0) return TRUE; // no output formats enabled.

  DocText *root = validatingParseText(textStr);

  for (it.toFirst();(og=it.current());++it)
  {
    if (og->isEnabled()) og->writeDoc(root,0,0);
  }

  bool isEmpty = root->isEmpty();

  delete root;

  return isEmpty;
}

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.

Definition at line 121 of file outputlist.cpp.

{
  QListIterator<OutputGenerator> it(m_outputs);
  OutputGenerator *og;
  for (it.toFirst();(og=it.current());++it)
  {
    og->popGeneratorState();
  }
}

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.

Definition at line 111 of file outputlist.cpp.

{
  QListIterator<OutputGenerator> it(m_outputs);
  OutputGenerator *og;
  for (it.toFirst();(og=it.current());++it)
  {
    og->pushGeneratorState();
  }
}

void OutputList::setCurrentDoc ( Definition *  context, const char *  anchor, bool  isSourceFile  )

inlinevirtual

Implements CodeOutputInterface.

Definition at line 480 of file outputlist.h.

    { forall(&OutputGenerator::setCurrentDoc,context,anchor,isSourceFile); }

void OutputList::startAnonTypeScope ( int  i1 )

inline

Definition at line 214 of file outputlist.h.

    { forall(&OutputGenerator::startAnonTypeScope,i1); }

void OutputList::startBold ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 304 of file outputlist.h.

    { forall(&OutputGenerator::startBold); }

void OutputList::startCallGraph ( )

inline

Definition at line 390 of file outputlist.h.

    { forall(&OutputGenerator::startCallGraph); }

void OutputList::startCenter ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 294 of file outputlist.h.

    { forall(&OutputGenerator::startCenter); }

void OutputList::startClassDiagram ( )

inline

Definition at line 342 of file outputlist.h.

    { forall(&OutputGenerator::startClassDiagram); }

void OutputList::startCodeFragment ( )

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

Implements BaseOutputDocInterface.

Definition at line 244 of file outputlist.h.

    { forall(&OutputGenerator::startCodeFragment); }

void OutputList::startCodeLine ( bool  hasLineNumbers )

inlinevirtual

Implements CodeOutputInterface.

Definition at line 248 of file outputlist.h.

    { forall(&OutputGenerator::startCodeLine,hasLineNumbers); }

void OutputList::startConstraintDocs ( )

inline

Definition at line 443 of file outputlist.h.

    { forall(&OutputGenerator::startConstraintDocs); }

void OutputList::startConstraintList ( const char *  header )

inline

Definition at line 433 of file outputlist.h.

    { forall(&OutputGenerator::startConstraintList,header); }

void OutputList::startConstraintParam ( )

inline

Definition at line 435 of file outputlist.h.

    { forall(&OutputGenerator::startConstraintParam); }

void OutputList::startConstraintType ( )

inline

Definition at line 439 of file outputlist.h.

    { forall(&OutputGenerator::startConstraintType); }

void OutputList::startContents ( )

inline

Definition at line 364 of file outputlist.h.

    { forall(&OutputGenerator::startContents); }

void OutputList::startDescForItem ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 282 of file outputlist.h.

    { forall(&OutputGenerator::startDescForItem); }

void OutputList::startDescItem ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 278 of file outputlist.h.

    { forall(&OutputGenerator::startDescItem); }

void OutputList::startDescription ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 274 of file outputlist.h.

    { forall(&OutputGenerator::startDescription); }

void OutputList::startDescTable ( const char *  title )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 370 of file outputlist.h.

    { forall(&OutputGenerator::startDescTable,title); }

void OutputList::startDescTableData ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 378 of file outputlist.h.

    { forall(&OutputGenerator::startDescTableData); }

void OutputList::startDescTableTitle ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 374 of file outputlist.h.

    { forall(&OutputGenerator::startDescTableTitle); }

void OutputList::startDirDepGraph ( )

inline

Definition at line 394 of file outputlist.h.

    { forall(&OutputGenerator::startDirDepGraph); }

void OutputList::startDotGraph ( )

inline

Definition at line 382 of file outputlist.h.

    { forall(&OutputGenerator::startDotGraph); }

void OutputList::startDoxyAnchor ( const char *  fName, const char *  manName, const char *  anchor, const char *  name, const char *  args  )

inline

Definition at line 266 of file outputlist.h.

    { forall(&OutputGenerator::startDoxyAnchor,fName,manName,anchor,name,args); }

void OutputList::startEmphasis ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 255 of file outputlist.h.

    { forall(&OutputGenerator::startEmphasis); }

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

inline

Definition at line 97 of file outputlist.h.

    { forall(&OutputGenerator::startFile,name,manName,title); }

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.

Definition at line 474 of file outputlist.h.

    { forall(&OutputGenerator::startFontClass,c); }

void OutputList::startGroupCollaboration ( )

inline

Definition at line 398 of file outputlist.h.

    { forall(&OutputGenerator::startGroupCollaboration); }

void OutputList::startGroupHeader ( int  extraLevels = 0 )

inline

Definition at line 176 of file outputlist.h.

    { forall(&OutputGenerator::startGroupHeader,extraLevels); }

void OutputList::startHeaderSection ( )

inline

Definition at line 190 of file outputlist.h.

    { forall(&OutputGenerator::startHeaderSection); }

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.

Definition at line 163 of file outputlist.h.

    { forall(&OutputGenerator::startHtmlLink,url); }

void OutputList::startInclDepGraph ( )

inline

Definition at line 386 of file outputlist.h.

    { forall(&OutputGenerator::startInclDepGraph); }

void OutputList::startIndent ( )

inline

Definition at line 330 of file outputlist.h.

    { forall(&OutputGenerator::startIndent); }

void OutputList::startIndexItem ( const char *  ref, const char *  file  )

inline

Definition at line 141 of file outputlist.h.

    { forall(&OutputGenerator::startIndexItem,ref,file); }

void OutputList::startIndexKey ( )

inline

Definition at line 129 of file outputlist.h.

    { forall(&OutputGenerator::startIndexKey); }

void OutputList::startIndexList ( )

inline

Definition at line 125 of file outputlist.h.

    { forall(&OutputGenerator::startIndexList); }

void OutputList::startIndexListItem ( )

inline

Definition at line 121 of file outputlist.h.

    { forall(&OutputGenerator::startIndexListItem); }

void OutputList::startIndexSection ( IndexSections  is )

inline

Definition at line 85 of file outputlist.h.

    { forall(&OutputGenerator::startIndexSection,is); }

void OutputList::startIndexValue ( bool  b )

inline

Definition at line 133 of file outputlist.h.

    { forall(&OutputGenerator::startIndexValue,b); }

void OutputList::startInlineHeader ( )

inline

Definition at line 210 of file outputlist.h.

    { forall(&OutputGenerator::startInlineHeader); }

void OutputList::startInlineMemberDoc ( )

inline

Definition at line 462 of file outputlist.h.

    { forall(&OutputGenerator::startInlineMemberDoc); }

void OutputList::startInlineMemberName ( )

inline

Definition at line 458 of file outputlist.h.

    { forall(&OutputGenerator::startInlineMemberName); }

void OutputList::startInlineMemberType ( )

inline

Definition at line 454 of file outputlist.h.

    { forall(&OutputGenerator::startInlineMemberType); }

void OutputList::startItemList ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 137 of file outputlist.h.

    { forall(&OutputGenerator::startItemList); }

void OutputList::startItemListItem ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 182 of file outputlist.h.

    { forall(&OutputGenerator::startItemListItem); }

void OutputList::startLabels ( )

inline

Definition at line 467 of file outputlist.h.

    { forall(&OutputGenerator::startLabels); }

void OutputList::startMemberDeclaration ( )

inline

Definition at line 312 of file outputlist.h.

    { forall(&OutputGenerator::startMemberDeclaration); }

void OutputList::startMemberDescription ( const char *  anchor, const char *  inheritId = 0  )

inline

Definition at line 308 of file outputlist.h.

    { forall(&OutputGenerator::startMemberDescription,anchor,inheritId); }

void OutputList::startMemberDoc ( const char *  clName, const char *  memName, const char *  anchor, const char *  title, bool  showInline  )

inline

Definition at line 261 of file outputlist.h.

    { forall(&OutputGenerator::startMemberDoc,clName,memName,anchor,title,showInline); }

void OutputList::startMemberDocList ( )

inline

Definition at line 202 of file outputlist.h.

    { forall(&OutputGenerator::startMemberDocList); }

void OutputList::startMemberDocName ( bool  align )

inline

Definition at line 414 of file outputlist.h.

    { forall(&OutputGenerator::startMemberDocName,align); }

void OutputList::startMemberDocPrefixItem ( )

inline

Definition at line 410 of file outputlist.h.

    { forall(&OutputGenerator::startMemberDocPrefixItem); }

void OutputList::startMemberDocSimple ( )

inline

Definition at line 450 of file outputlist.h.

    { forall(&OutputGenerator::startMemberDocSimple); }

void OutputList::startMemberGroup ( )

inline

Definition at line 234 of file outputlist.h.

    { forall(&OutputGenerator::startMemberGroup); }

void OutputList::startMemberGroupDocs ( )

inline

Definition at line 230 of file outputlist.h.

    { forall(&OutputGenerator::startMemberGroupDocs); }

void OutputList::startMemberGroupHeader ( bool  b )

inline

Definition at line 226 of file outputlist.h.

    { forall(&OutputGenerator::startMemberGroupHeader,b); }

void OutputList::startMemberHeader ( const char *  anchor )

inline

Definition at line 194 of file outputlist.h.

    { forall(&OutputGenerator::startMemberHeader,anchor); }

void OutputList::startMemberItem ( const char *  anchor, int  i1, const char *  id = 0  )

inline

Definition at line 218 of file outputlist.h.

    { forall(&OutputGenerator::startMemberItem,anchor,i1,id); }

void OutputList::startMemberList ( )

inline

Definition at line 206 of file outputlist.h.

    { forall(&OutputGenerator::startMemberList); }

void OutputList::startMemberSections ( )

inline

Definition at line 186 of file outputlist.h.

    { forall(&OutputGenerator::startMemberSections); }

void OutputList::startMemberSubtitle ( )

inline

Definition at line 198 of file outputlist.h.

    { forall(&OutputGenerator::startMemberSubtitle); }

void OutputList::startMemberTemplateParams ( )

inline

Definition at line 222 of file outputlist.h.

    { forall(&OutputGenerator::startMemberTemplateParams); }

void OutputList::startPageRef ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 346 of file outputlist.h.

    { forall(&OutputGenerator::startPageRef); }

void OutputList::startParagraph ( )

inlinevirtual

Starts a new paragraph

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 115 of file outputlist.h.

    { forall(&OutputGenerator::startParagraph); }

void OutputList::startParameterList ( bool  openBracket )

inline

Definition at line 426 of file outputlist.h.

    { forall(&OutputGenerator::startParameterList,openBracket); }

void OutputList::startParameterName ( bool  one )

inline

Definition at line 422 of file outputlist.h.

    { forall(&OutputGenerator::startParameterName,one); }

void OutputList::startParameterType ( bool  first, const char *  key  )

inline

Definition at line 418 of file outputlist.h.

    { forall(&OutputGenerator::startParameterType,first,key); }

void OutputList::startParamList ( ParamListTypes  t, const char *  title  )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 326 of file outputlist.h.

    { forall(&OutputGenerator::startParamList,t,title); }

void OutputList::startPlainFile ( const char *  name )

inline

Definition at line 485 of file outputlist.h.

    {
      QListIterator<OutputGenerator> it(m_outputs);
      OutputGenerator *og;
      for (;(og=it.current());++it)
      {
        if (og->isEnabled()) (og->startPlainFile)(name);
      }
    }

void OutputList::startProjectNumber ( )

inline

Definition at line 91 of file outputlist.h.

    { forall(&OutputGenerator::startProjectNumber); }

void OutputList::startQuickIndices ( )

inline

Definition at line 350 of file outputlist.h.

    { forall(&OutputGenerator::startQuickIndices); }

void OutputList::startSection ( const char *  lab, const char *  title, SectionInfo::SectionType  t  )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 334 of file outputlist.h.

    { forall(&OutputGenerator::startSection,lab,title,t); }

void OutputList::startSimpleSect ( SectionTypes  t, const char *  file, const char *  anchor, const char *  title  )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 321 of file outputlist.h.

    { forall(&OutputGenerator::startSimpleSect,t,file,anchor,title); }

void OutputList::startSmall ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 298 of file outputlist.h.

    { forall(&OutputGenerator::startSmall); }

void OutputList::startSubsection ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 286 of file outputlist.h.

    { forall(&OutputGenerator::startSubsection); }

void OutputList::startSubsubsection ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 290 of file outputlist.h.

    { forall(&OutputGenerator::startSubsubsection); }

void OutputList::startTextBlock ( bool  dense = FALSE )

inline

Definition at line 404 of file outputlist.h.

    { forall(&OutputGenerator::startTextBlock,dense); }

void OutputList::startTextLink ( const char *  file, const char *  anchor  )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 159 of file outputlist.h.

    { forall(&OutputGenerator::startTextLink,file,anchor); }

void OutputList::startTitle ( )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 109 of file outputlist.h.

    { forall(&OutputGenerator::startTitle); }

void OutputList::startTitleHead ( const char *  fileName )

inline

Definition at line 105 of file outputlist.h.

    { forall(&OutputGenerator::startTitleHead,fileName); }

void OutputList::startTypewriter ( )

inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 172 of file outputlist.h.

    { forall(&OutputGenerator::startTypewriter); }

void OutputList::writeAnchor ( const char *  fileName, const char *  name  )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 242 of file outputlist.h.

    { forall(&OutputGenerator::writeAnchor,fileName,name); }

void OutputList::writeChar ( char  c )

inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 259 of file outputlist.h.

    { forall(&OutputGenerator::writeChar,c); }

void OutputList::writeCodeAnchor ( const char *  name )

inlinevirtual

Write an anchor to a source listing.

Parameters

name	The name of the anchor.

Implements CodeOutputInterface.

Definition at line 478 of file outputlist.h.

    { forall(&OutputGenerator::writeCodeAnchor,name); }

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.

Definition at line 152 of file outputlist.h.

    { forall(&OutputGenerator::writeCodeLink,ref,file,anchor,name,tooltip); }

void OutputList::writeDoc	(	DocRoot *	root,
		Definition *	ctx,
		MemberDef *	md
	)

Definition at line 162 of file outputlist.cpp.

{
  QListIterator<OutputGenerator> it(m_outputs);
  OutputGenerator *og;
  for (it.toFirst();(og=it.current());++it)
  {
    //printf("og->printDoc(extension=%s)\n",
    //    ctx?ctx->getDefFileExtension().data():"<null>");
    if (og->isEnabled()) og->writeDoc(root,ctx,md);
  }
  VhdlDocGen::setFlowMember(0);
}

void OutputList::writeEndAnnoItem ( const char *  name )

inline

Definition at line 170 of file outputlist.h.

    { forall(&OutputGenerator::writeEndAnnoItem,name); }

void OutputList::writeFooter ( const char *  navPath )

inline

Definition at line 101 of file outputlist.h.

    { forall(&OutputGenerator::writeFooter,navPath); }

void OutputList::writeGraphicalHierarchy ( const DotGfxHierarchyTable &  g )

inline

Definition at line 402 of file outputlist.h.

    { forall(&OutputGenerator::writeGraphicalHierarchy,g); }

void OutputList::writeInheritedSectionTitle ( const char *  id, const char *  ref, const char *  file, const char *  anchor, const char *  title, const char *  name  )

inline

Definition at line 316 of file outputlist.h.

    { forall(&OutputGenerator::writeInheritedSectionTitle,id,ref,
                                    file,anchor,title,name); }

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

inline

Definition at line 469 of file outputlist.h.

    { forall(&OutputGenerator::writeLabel,l,isLast); }

void OutputList::writeLatexSpacing ( )

inline

Definition at line 272 of file outputlist.h.

    { forall(&OutputGenerator::writeLatexSpacing); }

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.

Definition at line 252 of file outputlist.h.

    { forall(&OutputGenerator::writeLineNumber,ref,file,anchor,lineNumber); }

void OutputList::writeLogo ( )

inline

Definition at line 358 of file outputlist.h.

    { forall(&OutputGenerator::writeLogo); }

void OutputList::writeNavigationPath ( const char *  s )

inline

Definition at line 356 of file outputlist.h.

    { forall(&OutputGenerator::writeNavigationPath,s); }

void OutputList::writeNonBreakableSpace ( int  num )

inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 368 of file outputlist.h.

    { forall(&OutputGenerator::writeNonBreakableSpace,num); }

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.

Definition at line 149 of file outputlist.h.

    { forall(&OutputGenerator::writeObjectLink,ref,file,anchor,name); }

void OutputList::writePageLink ( const char *  name, bool  first  )

inline

Definition at line 89 of file outputlist.h.

    { forall(&OutputGenerator::writePageLink,name,first); }

void OutputList::writeQuickLinks ( bool  compact, HighlightedItem  hli, const char *  file  )

inline

Definition at line 360 of file outputlist.h.

    { forall(&OutputGenerator::writeQuickLinks,compact,hli,file); }

void OutputList::writeRuler ( )

inlinevirtual

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

Definition at line 240 of file outputlist.h.

    { forall(&OutputGenerator::writeRuler); }

void OutputList::writeSearchInfo ( )

inline

Definition at line 99 of file outputlist.h.

    { forall(&OutputGenerator::writeSearchInfo); }

void OutputList::writeSplitBar ( const char *  name )

inline

Definition at line 354 of file outputlist.h.

    { forall(&OutputGenerator::writeSplitBar,name); }

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

inline

Definition at line 167 of file outputlist.h.

    { forall(&OutputGenerator::writeStartAnnoItem,type,file,path,name); }

void OutputList::writeString ( const char *  text )

inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 119 of file outputlist.h.

    { forall(&OutputGenerator::writeString,text); }

void OutputList::writeStyleInfo ( int  part )

inline

Definition at line 95 of file outputlist.h.

    { forall(&OutputGenerator::writeStyleInfo,part); }

void OutputList::writeSummaryLink ( const char *  file, const char *  anchor, const char *  title, bool  first  )

inline

Definition at line 362 of file outputlist.h.

    { forall(&OutputGenerator::writeSummaryLink,file,anchor,title,first); }

void OutputList::writeSynopsis ( )

inline

Definition at line 340 of file outputlist.h.

    { forall(&OutputGenerator::writeSynopsis); }

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.

Definition at line 156 of file outputlist.h.

    { forall(&OutputGenerator::writeTooltip,id,docInfo,decl,desc,defInfo,declInfo); }

Member Data Documentation

QList<OutputGenerator> OutputList::m_outputs

private

Definition at line 551 of file outputlist.h.

---

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

• doxygen-1.8.11/src/outputlist.h
• doxygen-1.8.11/src/outputlist.cpp