doxygen
Public Member Functions | List of all members
XMLCodeGenerator Class Reference
Inheritance diagram for XMLCodeGenerator:
Inheritance graph
[legend]
Collaboration diagram for XMLCodeGenerator:
Collaboration graph
[legend]

Public Member Functions

 XMLCodeGenerator (TextStream &t)
 
void codify (const QCString &text) override
 Generator for producing XML formatted source code. More...
 
void writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) override
 
void writeTooltip (const QCString &, const DocLinkInfo &, const QCString &, const QCString &, const SourceLinkInfo &, const SourceLinkInfo &) override
 
void startCodeLine (bool) override
 
void endCodeLine () override
 
void startFontClass (const QCString &colorClass) override
 
void endFontClass () override
 
void writeCodeAnchor (const QCString &) override
 
void writeLineNumber (const QCString &extRef, const QCString &compId, const QCString &anchorId, int l, bool writeLineAnchor) override
 
void setCurrentDoc (const Definition *, const QCString &, bool) override
 
void addWord (const QCString &, bool) override
 
void startCodeFragment (const QCString &) override
 
void endCodeFragment (const QCString &) override
 
void finish ()
 
- Public Member Functions inherited from CodeOutputInterface
 CodeOutputInterface (const CodeOutputInterface &)=delete
 
CodeOutputInterfaceoperator= (const CodeOutputInterface &)=delete
 
virtual int id () const
 Identifier for the output file.
 

Member Function Documentation

◆ codify()

void XMLCodeGenerator::codify ( const QCString text)
overridevirtual

Generator for producing XML formatted source code.

Implements CodeOutputInterface.

◆ endCodeFragment()

void XMLCodeGenerator::endCodeFragment ( const QCString style)
overridevirtual

Ends a block of code

Implements CodeOutputInterface.

◆ endCodeLine()

void XMLCodeGenerator::endCodeLine ( )
overridevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

◆ endFontClass()

void XMLCodeGenerator::endFontClass ( )
overridevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

◆ startCodeFragment()

void XMLCodeGenerator::startCodeFragment ( const QCString style)
overridevirtual

Starts a source code fragment. The fragment will be fed to the code parser (see code.h) for syntax highlighting and cross-referencing. The fragment ends by a call to endCodeFragment()

Parameters
styleThe kind of code fragment.

Implements CodeOutputInterface.

◆ startFontClass()

void XMLCodeGenerator::startFontClass ( const QCString clsName)
overridevirtual

Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.

Parameters
clsNameThe category name.

Implements CodeOutputInterface.

◆ writeCodeAnchor()

void XMLCodeGenerator::writeCodeAnchor ( const QCString name)
overridevirtual

Write an anchor to a source listing.

Parameters
nameThe name of the anchor.

Implements CodeOutputInterface.

◆ writeCodeLink()

void XMLCodeGenerator::writeCodeLink ( CodeSymbolType  type,
const QCString ref,
const QCString file,
const QCString anchor,
const QCString name,
const QCString tooltip 
)
overridevirtual

Writes a link to an object in a code fragment.

Parameters
typeThe type of symbol, used for semantic syntax highlighting, may be Default is no info is available.
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.
tooltipThe tooltip to display when the mouse is on the link.

Implements CodeOutputInterface.

◆ writeLineNumber()

void XMLCodeGenerator::writeLineNumber ( const QCString ref,
const QCString file,
const QCString anchor,
int  lineNumber,
bool  writeLineAnchor 
)
overridevirtual

Writes the line number of a source listing

Parameters
refExternal reference (when imported from a tag file)
fileThe file part of the URL pointing to the docs.
anchorThe anchor part of the URL pointing to the docs.
lineNumberThe line number to write
writeLineAnchorIndicates if an anchor for the line number needs to be written

Implements CodeOutputInterface.

◆ writeTooltip()

void XMLCodeGenerator::writeTooltip ( const QCString id,
const DocLinkInfo docInfo,
const QCString decl,
const QCString desc,
const SourceLinkInfo defInfo,
const SourceLinkInfo declInfo 
)
overridevirtual

Writes a tool tip definition

Parameters
idunique identifier for the tooltip
docInfoInfo about the symbol's documentation.
declfull declaration of the symbol (for functions)
descbrief description for the symbol
defInfoInfo about the symbol's definition in the source code
declInfoInfo about the symbol's declaration in the source code

Implements CodeOutputInterface.


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