HtmlCodeGenerator Class Reference

Inheritance diagram for HtmlCodeGenerator:

Public Member Functions
	HtmlCodeGenerator (FTextStream &t, const QCString &relPath)
void	setTextStream (FTextStream &t)
void	setRelativePath (const QCString &path)
void	codify (const char *text)
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	writeLineNumber (const char *, const char *, const char *, int)
void	startCodeLine (bool)
void	endCodeLine ()
void	startFontClass (const char *s)
void	endFontClass ()
void	writeCodeAnchor (const char *anchor)
void	setCurrentDoc (Definition *, const char *, bool)
void	addWord (const char *, bool)

Member Function Documentation

codify()

void HtmlCodeGenerator::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.

endCodeLine()

void HtmlCodeGenerator::endCodeLine ( )

virtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

endFontClass()

void HtmlCodeGenerator::endFontClass ( )

virtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

startFontClass()

void HtmlCodeGenerator::startFontClass ( const char *  clsName )

virtual

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.

writeCodeAnchor()

void HtmlCodeGenerator::writeCodeAnchor ( const char *  name )

virtual

Write an anchor to a source listing.

Parameters

name	The name of the anchor.

Implements CodeOutputInterface.

writeCodeLink()

void HtmlCodeGenerator::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 HtmlCodeGenerator::writeLineNumber ( const char *  ref, const char *  file, const char *  anchor, int  lineNumber  )

virtual

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.

writeTooltip()

void HtmlCodeGenerator::writeTooltip ( const char *  id, const DocLinkInfo &  docInfo, const char *  decl, const char *  desc, const SourceLinkInfo &  defInfo, const SourceLinkInfo &  declInfo  )

virtual

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/htmlgen.h
• src/htmlgen.cpp