DevNullCodeDocInterface Class Reference

Inheritance diagram for DevNullCodeDocInterface:

Public Member Functions
virtual void	codify (const char *)
virtual void	writeCodeLink (const char *, const char *, const char *, const char *, const char *)
virtual void	writeTooltip (const char *, const DocLinkInfo &, const char *, const char *, const SourceLinkInfo &, const SourceLinkInfo &)
virtual void	writeLineNumber (const char *, const char *, const char *, int)
virtual void	startCodeLine (bool)
virtual void	endCodeLine ()
virtual void	startFontClass (const char *)
virtual void	endFontClass ()
virtual void	writeCodeAnchor (const char *)
virtual void	linkableSymbol (int, const char *, Definition *, Definition *)
virtual void	setCurrentDoc (Definition *, const char *, bool)
virtual void	addWord (const char *, bool)
Public Member Functions inherited from CodeOutputInterface
virtual	~CodeOutputInterface ()

Detailed Description

Class implementing CodeOutputInterface by throwing away everything.

Definition at line 50 of file filedef.cpp.

Member Function Documentation

virtual void DevNullCodeDocInterface::addWord ( const char *  , bool    )

inlinevirtual

Implements CodeOutputInterface.

Definition at line 69 of file filedef.cpp.

{}

virtual void DevNullCodeDocInterface::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 53 of file filedef.cpp.

{}

virtual void DevNullCodeDocInterface::endCodeLine ( )

inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

Definition at line 63 of file filedef.cpp.

{}

virtual void DevNullCodeDocInterface::endFontClass ( )

inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

Definition at line 65 of file filedef.cpp.

{}

virtual void DevNullCodeDocInterface::linkableSymbol ( int  , const char *  , Definition *  , Definition *    )

inlinevirtual

Definition at line 67 of file filedef.cpp.

{}

virtual void DevNullCodeDocInterface::setCurrentDoc ( Definition *  , const char *  , bool    )

inlinevirtual

Implements CodeOutputInterface.

Definition at line 68 of file filedef.cpp.

{}

virtual void DevNullCodeDocInterface::startCodeLine ( bool  )

inlinevirtual

Implements CodeOutputInterface.

Definition at line 62 of file filedef.cpp.

{}

virtual void DevNullCodeDocInterface::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 64 of file filedef.cpp.

{}

virtual void DevNullCodeDocInterface::writeCodeAnchor ( const char *  name )

inlinevirtual

Write an anchor to a source listing.

Parameters

name	The name of the anchor.

Implements CodeOutputInterface.

Definition at line 66 of file filedef.cpp.

{}

virtual void DevNullCodeDocInterface::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 54 of file filedef.cpp.

                                             {}

virtual void DevNullCodeDocInterface::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 60 of file filedef.cpp.

                                                   {}

virtual void DevNullCodeDocInterface::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 57 of file filedef.cpp.

                               {}

---

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

• doxygen-1.8.11/src/filedef.cpp