| fb-doc 0.2 documentation tool for FreeBasic

- Main Page
- Tutorial
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Functions | Variables
fb-doc_emit_doxy.bas File Reference

Emitter for Doxygen templates. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Functions

SUB_CDECL | doxy_entryListPara (BYVAL_AS_Parser_PTR P)
| Emitter to generate a line for a parameter list entry. More...
SUB_CDECL | doxy_func_ (BYVAL_AS_Parser_PTR P)
| Emitter to generate a template for a function. More...
SUB_CDECL | doxy_decl_ (BYVAL_AS_Parser_PTR P)
| Emitter to generate a template for a declaration. More...
SUB_CDECL | doxy_defi_ (BYVAL_AS_Parser_PTR P)
| Emitter to generate a templates for a macro. More...
SUB_CDECL | doxy_emitBlockNames (BYVAL_AS_Parser_PTR P)
| Emitter to generate a line for a block entry. More...
SUB_CDECL | doxy_Block (BYVAL_AS_Parser_PTR P)
| Emitter to generate templates for blocks. More...
SUB_CDECL | doxy_empty (BYVAL_AS_Parser_PTR P)
| Emitter for an empty Geany block. More...

## Variables

const VAR | DOXY_START = NL & "/'* "
| the start of a comment block More...
const VAR | DOXY_END = NL &
| the end of a comment block More...

## Detailed Description

Emitter for Doxygen templates.

This file contains emitter functions for the EmitterIF to generate template blocks for the Doxygen Back-end. It's designed to be used in Geany mode (see section Doxygen for an example).

The emitters return all original source code unchanged. Additionally relevant lines (or code blocks) get prepended by a multi line block of documentation. This works for SUBs/FUNCTIONs, TYPE, UNION and ENUM blocks, declarations (VAR / DIM / CONST / COMMON / EXTERN / STATIC) and #DEFINEs / #MACROs.

The block starts with the C declaration of the construct and a line for the brief description. Then the members are listed with leading param or var keyword and followed by a line for the brief description. The block ends by a FIXME text for the detailed description.

Since the prefered way to document variables with Doxygen is to write the comment behind the variable, this emitter is mostly helpful for documenting functions and their parameter lists.

When an empty line is send by Geany, the text of the doxy_empty() function gets emitted. This is a comment block template to describe the source file. (The text can be replaced by the context of the file empty.txt.)

Definition in file fb-doc_emit_doxy.bas.

## Function Documentation

SUB_CDECL doxy_entryListPara | ( | BYVAL_AS_Parser_PTR | P) |  |

Emitter to generate a line for a parameter list entry.

Parameters

  P | the parser calling this emitter

This emitter gets called when the parser is in a parameter list of a function (SUB / FUNCTION / PROPERTY / CONSTRUCTOR / DESTRUCTOR). It generates a line for each parameter and sends it (them) to the output stream.

Definition at line 48 of file fb-doc_emit_doxy.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL doxy_func_ | ( | BYVAL_AS_Parser_PTR | P) |  |

Emitter to generate a template for a function.

Parameters

  P | the parser calling this emitter

This emitter gets called when the parser finds a function (SUB / FUNCTION / PROPERTY / CONSTRUCTOR / DESTRUCTOR). It generates a template to document the function and its parameter list and sends it to the output stream.

Definition at line 64 of file fb-doc_emit_doxy.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL doxy_decl_ | ( | BYVAL_AS_Parser_PTR | P) |  |

Emitter to generate a template for a declaration.

Parameters

  P | the parser calling this emitter

This emitter gets called when the parser is in a declaration (VAR / DIM / CONST / COMMON / EXTERN / STATIC). It generates a line for each variable name and sends it (them) to the output stream.

Definition at line 88 of file fb-doc_emit_doxy.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL doxy_defi_ | ( | BYVAL_AS_Parser_PTR | P) |  |

Emitter to generate a templates for a macro.

Parameters

  P | the parser calling this emitter

This emitter gets called when the parser finds a macro (#DEFINE / #MACRO). It generates a template to document the macro and sends it to the output stream.

Definition at line 141 of file fb-doc_emit_doxy.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL doxy_emitBlockNames | ( | BYVAL_AS_Parser_PTR | P) |  |

Emitter to generate a line for a block entry.

Parameters

  P | the parser calling this emitter

This emitter gets called when the parser is in a block (TYPE / ENUM / UNION). It generates a line for each member and sends it (them) to the output stream.

Definition at line 159 of file fb-doc_emit_doxy.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL doxy_Block | ( | BYVAL_AS_Parser_PTR | P) |  |

Emitter to generate templates for blocks.

Parameters

  P | the parser calling this emitter

This emitter gets called when the parser finds a block (TYPE / UNION / ENUM). It generates a template to document the block with one line for each member and sends it to the output stream.

Definition at line 185 of file fb-doc_emit_doxy.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL doxy_empty | ( | BYVAL_AS_Parser_PTR | P) |  |

Emitter for an empty Geany block.

Parameters

  P | the parser calling this emitter

This emitter gets called when an empty block gets send by Geany and no file Empty.txt exists. The emitter generates a template to document the source file and sends it to the output stream.

Definition at line 225 of file fb-doc_emit_doxy.bas.

Here is the caller graph for this function:

## Variable Documentation

const VAR DOXY_START = NL & "/'* "

the start of a comment block

Definition at line 33 of file fb-doc_emit_doxy.bas.

const VAR DOXY_END = NL &

the end of a comment block

Definition at line 34 of file fb-doc_emit_doxy.bas.