| 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_callees.bas File Reference

Emitter for the file fb-doc.lfn. More...

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

Go to the source code of this file.

## Functions

SUB_CDECL | callees_decl_ (BYVAL_AS_Parser_PTR P)
| Emitter to generate a declaration line. More...
SUB_CDECL | callees_class_ (BYVAL_AS_Parser_PTR P)
| Emitter to start parsing of blocks. More...
SUB_CDECL | callees_func_ (BYVAL_AS_Parser_PTR P)
| Emitter to generate a line for a function name. More...
SUB_CDECL | callees_include (BYVAL_AS_Parser_PTR P)
| Emitter to import a source file. More...

## Variables

const VAR | CALLEE_TR = !"\n"
| Separator for entries in file fb-doc.lfn. More...

## Detailed Description

Emitter for the file fb-doc.lfn.

This file contains emitter functions for the EmitterIF to generate the file fb-doc.lfn for the Doxygen Back-end. It's the default emitter in –list mode.

The emitters writes the names of all functions (SUB / FUNCTION / PROPERTY) to the output stream, one in a line, separated by a new line character "CHR(10)".

Definition in file fb-doc_emit_callees.bas.

## Function Documentation

SUB_CDECL callees_decl_ | ( | BYVAL_AS_Parser_PTR | P) |  |

Emitter to generate a declaration line.

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 24 of file fb-doc_emit_callees.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL callees_class_ | ( | BYVAL_AS_Parser_PTR | P) |  |

Emitter to start parsing of blocks.

Parameters

  P | the parser calling this emitter

This emitter gets called when the parser finds a block (TYPE / UNION / ENUM). It starts the scanning process in the block.

Definition at line 44 of file fb-doc_emit_callees.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL callees_func_ | ( | BYVAL_AS_Parser_PTR | P) |  |

Emitter to generate a line for a function name.

Parameters

  P | the parser calling this emitter

This emitter gets called when the parser finds a function (SUB / FUNCTION / PROPERTY). It generates a line with the name of the function and sends it to the output stream.

Definition at line 59 of file fb-doc_emit_callees.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL callees_include | ( | BYVAL_AS_Parser_PTR | P) |  |

Emitter to import a source file.

Parameters

  P | the parser calling this emitter

This emitter gets called when the parser finds an #INCLUDE statement and option –recursiv is given. It checks if the file has been done allready. If not, it creates a new Parser and starts the scanning process.

Definition at line 76 of file fb-doc_emit_callees.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

## Variable Documentation

const VAR CALLEE_TR = !"\n"

Separator for entries in file fb-doc.lfn.

Definition at line 14 of file fb-doc_emit_callees.bas.