The OutputCodeIntf Class Reference

Base class for code generators. More...

Declaration

class OutputCodeIntf { ... }

Included Headers

#include <src/outputgen.h>

Derived Classes

class	OutputCodeDefer<OutputCodeGen>
	Helper template class which defers all methods of OutputCodeIntf to an existing object of the templated type. More...
class	OutputCodeDefer<OutputCodeGen>
	Helper template class which defers all methods of OutputCodeIntf to an existing object of the templated type. More...
class	OutputCodeDefer<OutputCodeGen>
	Helper template class which defers all methods of OutputCodeIntf to an existing object of the templated type. More...
class	OutputCodeDefer<OutputCodeGen>
	Helper template class which defers all methods of OutputCodeIntf to an existing object of the templated type. More...
class	OutputCodeDefer<OutputCodeGen>
	Helper template class which defers all methods of OutputCodeIntf to an existing object of the templated type. More...
class	OutputCodeDefer<OutputCodeGen>
	Helper template class which defers all methods of OutputCodeIntf to an existing object of the templated type. More...
class	DevNullCodeGenerator
	Class implementing OutputCodeIntf by throwing away everything. More...
class	DocbookCodeGenerator
class	HtmlCodeGenerator
	Generator for HTML code fragments. More...
class	LatexCodeGenerator
	Generator for LaTeX code fragments. More...
class	ManCodeGenerator
	Generator for Man page code fragments. More...
class	OutputCodeDefer<OutputCodeGen>
	Helper template class which defers all methods of OutputCodeIntf to an existing object of the templated type. More...
class	OutputCodeRecorder
	Implementation that allows capturing calls made to the code interface to later invoke them on a OutputCodeList via replay(). More...
class	RTFCodeGenerator
	Generator for RTF code fragments. More...
class	XMLCodeGenerator

Public Constructors Index

	OutputCodeIntf ()=default

Public Member Functions Index

OutputType	type () const =0
std::unique_ptr< OutputCodeIntf >	clone ()=0
void	codify (const QCString &s)=0
void	stripCodeComments (bool b)=0
void	startSpecialComment ()=0
void	endSpecialComment ()=0
void	setStripIndentAmount (size_t)=0
void	writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)=0
void	writeLineNumber (const QCString &ref, const QCString &file, const QCString &anchor, int lineNumber, bool writeLineAnchor)=0
void	writeTooltip (const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)=0
void	startCodeLine (int lineNr)=0
void	endCodeLine ()=0
void	startFontClass (const QCString &c)=0
void	endFontClass ()=0
void	writeCodeAnchor (const QCString &name)=0
void	startCodeFragment (const QCString &style)=0
void	endCodeFragment (const QCString &style)=0
void	startFold (int lineNr, const QCString &startMarker, const QCString &endMarker)=0
void	endFold ()=0

Description

Base class for code generators.

Definition at line 64 of file outputgen.h.

Public Constructors

OutputCodeIntf()

OutputCodeIntf::OutputCodeIntf ()

default

Definition at line 67 of file outputgen.h.

Reference OutputCodeIntf.

Referenced by clone and OutputCodeIntf.

Public Member Functions

clone()

virtual std::unique_ptr< OutputCodeIntf > OutputCodeIntf::clone ()

Definition at line 71 of file outputgen.h.

References clone and OutputCodeIntf.

Referenced by clone.

codify()

virtual void OutputCodeIntf::codify (const QCString & s)

Definition at line 72 of file outputgen.h.

Reference codify.

Referenced by codify and OutputCodeList::codify.

endCodeFragment()

virtual void OutputCodeIntf::endCodeFragment (const QCString & style)

Definition at line 91 of file outputgen.h.

Reference endCodeFragment.

Referenced by endCodeFragment and OutputCodeList::endCodeFragment.

endCodeLine()

virtual void OutputCodeIntf::endCodeLine ()

Definition at line 86 of file outputgen.h.

Reference endCodeLine.

Referenced by endCodeLine and OutputCodeList::endCodeLine.

endFold()

virtual void OutputCodeIntf::endFold ()

Definition at line 93 of file outputgen.h.

Reference endFold.

Referenced by endFold and OutputCodeList::endFold.

endFontClass()

virtual void OutputCodeIntf::endFontClass ()

Definition at line 88 of file outputgen.h.

Reference endFontClass.

Referenced by endFontClass and OutputCodeList::endFontClass.

endSpecialComment()

virtual void OutputCodeIntf::endSpecialComment ()

Definition at line 75 of file outputgen.h.

Reference endSpecialComment.

Referenced by endSpecialComment and OutputCodeList::endSpecialComment.

setStripIndentAmount()

virtual void OutputCodeIntf::setStripIndentAmount (size_t)

Definition at line 76 of file outputgen.h.

Reference setStripIndentAmount.

Referenced by setStripIndentAmount and OutputCodeList::setStripIndentAmount.

startCodeFragment()

virtual void OutputCodeIntf::startCodeFragment (const QCString & style)

Definition at line 90 of file outputgen.h.

Reference startCodeFragment.

Referenced by startCodeFragment and OutputCodeList::startCodeFragment.

startCodeLine()

virtual void OutputCodeIntf::startCodeLine (int lineNr)

Definition at line 85 of file outputgen.h.

Reference startCodeLine.

Referenced by startCodeLine and OutputCodeList::startCodeLine.

startFold()

virtual void OutputCodeIntf::startFold (int lineNr, const QCString & startMarker, const QCString & endMarker)

Definition at line 92 of file outputgen.h.

Reference startFold.

Referenced by startFold and OutputCodeList::startFold.

startFontClass()

virtual void OutputCodeIntf::startFontClass (const QCString & c)

Definition at line 87 of file outputgen.h.

Reference startFontClass.

Referenced by startFontClass and OutputCodeList::startFontClass.

startSpecialComment()

virtual void OutputCodeIntf::startSpecialComment ()

Definition at line 74 of file outputgen.h.

Reference startSpecialComment.

Referenced by startSpecialComment and OutputCodeList::startSpecialComment.

stripCodeComments()

virtual void OutputCodeIntf::stripCodeComments (bool b)

Definition at line 73 of file outputgen.h.

Reference stripCodeComments.

Referenced by stripCodeComments and OutputCodeList::stripCodeComments.

type()

virtual OutputType OutputCodeIntf::type ()

Definition at line 70 of file outputgen.h.

Reference type.

Referenced by type and writeCodeLink.

writeCodeAnchor()

virtual void OutputCodeIntf::writeCodeAnchor (const QCString & name)

Definition at line 89 of file outputgen.h.

Reference writeCodeAnchor.

Referenced by writeCodeAnchor and OutputCodeList::writeCodeAnchor.

writeCodeLink()

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

Definition at line 77 of file outputgen.h.

References type and writeCodeLink.

Referenced by writeCodeLink and OutputCodeList::writeCodeLink.

writeLineNumber()

virtual void OutputCodeIntf::writeLineNumber (const QCString & ref, const QCString & file, const QCString & anchor, int lineNumber, bool writeLineAnchor)

Definition at line 81 of file outputgen.h.

Reference writeLineNumber.

Referenced by writeLineNumber and OutputCodeList::writeLineNumber.

writeTooltip()

virtual void OutputCodeIntf::writeTooltip (const QCString & id, const DocLinkInfo & docInfo, const QCString & decl, const QCString & desc, const SourceLinkInfo & defInfo, const SourceLinkInfo & declInfo)

Definition at line 83 of file outputgen.h.

Reference writeTooltip.

Referenced by writeTooltip and OutputCodeList::writeTooltip.

---

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

• outputgen.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.