BaseOutputDocInterface Class Reference
Base Interface used for generating output outside of the comment blocks.
More...
#include <outputgen.h>
Inheritance diagram for BaseOutputDocInterface:
List of all members.
Detailed Description
Base Interface used for generating output outside of the comment blocks.
This abstract class is used by output generation functions to generate the output for a specific format, or a list of formats (see OutputList). This interface contains functions that generate fragments of the output.
Definition at line 78 of file outputgen.h.
Member Function Documentation
| virtual void BaseOutputDocInterface::docify |
( |
const char * |
s |
) |
[pure virtual] |
|
|
|
Writes an ASCII string to the output. Converts characters that have A special meaning, like & in html. |
| virtual void BaseOutputDocInterface::endBold |
( |
|
) |
[pure virtual] |
|
|
|
End a section of text displayed in bold face. |
| virtual void BaseOutputDocInterface::endCodeFragment |
( |
|
) |
[pure virtual] |
|
|
|
Ends a source code fragment |
| virtual void BaseOutputDocInterface::endDescItem |
( |
|
) |
[pure virtual] |
|
|
|
Ends an item of a description list and starts the description itself: e.g. <dd> in HTML. |
| virtual void BaseOutputDocInterface::endDescription |
( |
|
) |
[pure virtual] |
|
|
|
Ends a description list: e.g. </dl> in HTML |
| virtual void BaseOutputDocInterface::endEmphasis |
( |
|
) |
[pure virtual] |
|
|
|
Ends a section of text displayed in italic. |
| virtual void BaseOutputDocInterface::endHtmlLink |
( |
|
) |
[pure virtual] |
|
| virtual void BaseOutputDocInterface::endItemList |
( |
|
) |
[pure virtual] |
|
|
|
Ends a bullet list: e.g. </ul> in html |
| virtual void BaseOutputDocInterface::endTypewriter |
( |
|
) |
[pure virtual] |
|
|
|
End a section of text displayed in typewriter style. |
| virtual void BaseOutputDocInterface::newParagraph |
( |
|
) |
[pure virtual] |
|
| virtual void BaseOutputDocInterface::startBold |
( |
|
) |
[pure virtual] |
|
|
|
Changes the text font to bold face. The bold section ends with endBold() |
| virtual void BaseOutputDocInterface::startCodeFragment |
( |
|
) |
[pure virtual] |
|
|
|
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() |
| virtual void BaseOutputDocInterface::startDescItem |
( |
|
) |
[pure virtual] |
|
|
|
Starts an item of a description list: e.g. <dt> in HTML. |
| virtual void BaseOutputDocInterface::startDescription |
( |
|
) |
[pure virtual] |
|
| virtual void BaseOutputDocInterface::startEmphasis |
( |
|
) |
[pure virtual] |
|
|
|
Changes the text font to italic. The italic section ends with endEmphasis() |
| virtual void BaseOutputDocInterface::startHtmlLink |
( |
const char * |
url |
) |
[pure virtual] |
|
|
|
Starts a (link to an) URL found in the documentation. - Parameters:
-
|
| virtual void BaseOutputDocInterface::startItemList |
( |
|
) |
[pure virtual] |
|
|
|
Start of a bullet list: e.g. <ul> in html. writeListItem() is Used for the bullet items. |
| virtual void BaseOutputDocInterface::startTypewriter |
( |
|
) |
[pure virtual] |
|
| virtual void BaseOutputDocInterface::writeChar |
( |
char |
c |
) |
[pure virtual] |
|
|
|
Writes a single ASCII character to the output. Converts characters that have a special meaning. |
| virtual void BaseOutputDocInterface::writeListItem |
( |
|
) |
[pure virtual] |
|
|
|
Writes a list item for a bullet or enumerated list: e.g. <li> in html |
| virtual void BaseOutputDocInterface::writeObjectLink |
( |
const char * |
ref, |
|
|
const char * |
file, |
|
|
const char * |
anchor, |
|
|
const char * |
name |
|
) |
[pure virtual] |
|
|
|
Writes a link to an object in the documentation. - 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. |
|
| virtual void BaseOutputDocInterface::writeRuler |
( |
|
) |
[pure virtual] |
|
|
|
Writes a horizontal ruler to the output |
| virtual void BaseOutputDocInterface::writeString |
( |
const char * |
text |
) |
[pure virtual] |
|
|
|
Writes an ASCII string to the output, without converting special characters. |
The documentation for this class was generated from the following file:
Generated on Sat Aug 21 19:11:54 2004 for Doxygen by
1.3.8