Class implementing CodeOutputInterface by throwing away everything.
More...
|
virtual void | codify (const QCString &) override |
|
virtual void | writeCodeLink (CodeSymbolType, const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) override |
|
virtual void | writeTooltip (const QCString &, const DocLinkInfo &, const QCString &, const QCString &, const SourceLinkInfo &, const SourceLinkInfo &) override |
|
virtual void | writeLineNumber (const QCString &, const QCString &, const QCString &, int, bool) override |
|
virtual void | startCodeLine (bool) override |
|
virtual void | endCodeLine () override |
|
virtual void | startFontClass (const QCString &) override |
|
virtual void | endFontClass () override |
|
virtual void | writeCodeAnchor (const QCString &) override |
|
virtual void | setCurrentDoc (const Definition *, const QCString &, bool) override |
|
virtual void | addWord (const QCString &, bool) override |
|
virtual void | startCodeFragment (const QCString &) override |
|
virtual void | endCodeFragment (const QCString &) override |
|
| CodeOutputInterface (const CodeOutputInterface &)=delete |
|
CodeOutputInterface & | operator= (const CodeOutputInterface &)=delete |
|
virtual int | id () const |
| Identifier for the output file.
|
|
Class implementing CodeOutputInterface by throwing away everything.
◆ codify()
virtual void DevNullCodeDocInterface::codify |
( |
const QCString & |
s | ) |
|
|
inlineoverridevirtual |
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.
◆ endCodeFragment()
virtual void DevNullCodeDocInterface::endCodeFragment |
( |
const QCString & |
style | ) |
|
|
inlineoverridevirtual |
◆ endCodeLine()
virtual void DevNullCodeDocInterface::endCodeLine |
( |
| ) |
|
|
inlineoverridevirtual |
◆ endFontClass()
virtual void DevNullCodeDocInterface::endFontClass |
( |
| ) |
|
|
inlineoverridevirtual |
◆ startCodeFragment()
virtual void DevNullCodeDocInterface::startCodeFragment |
( |
const QCString & |
style | ) |
|
|
inlineoverridevirtual |
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.
◆ startFontClass()
virtual void DevNullCodeDocInterface::startFontClass |
( |
const QCString & |
clsName | ) |
|
|
inlineoverridevirtual |
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()
virtual void DevNullCodeDocInterface::writeCodeAnchor |
( |
const QCString & |
name | ) |
|
|
inlineoverridevirtual |
Write an anchor to a source listing.
- Parameters
-
name | The name of the anchor. |
Implements CodeOutputInterface.
◆ writeCodeLink()
Writes a link to an object in a code fragment.
- Parameters
-
type | The type of symbol, used for semantic syntax highlighting, may be Default is no info is available. |
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()
virtual void DevNullCodeDocInterface::writeLineNumber |
( |
const QCString & |
ref, |
|
|
const QCString & |
file, |
|
|
const QCString & |
anchor, |
|
|
int |
lineNumber, |
|
|
bool |
writeLineAnchor |
|
) |
| |
|
inlineoverridevirtual |
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 |
writeLineAnchor | Indicates if an anchor for the line number needs to be written |
Implements CodeOutputInterface.
◆ writeTooltip()
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 file: