fbdoc_emit_lfn.bas File Reference

Emitter to generate the file fb-doc.lfn. More...

#include "fbdoc_options.bi"
#include "fbdoc_emit_lfn.bi"

Include dependency graph for fbdoc_emit_lfn.bas:

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

Go to the source code of this file.

Functions
FUNCTION_AS_INTEGER	startLFN (BYREF_AS_STRING Path)
SUB_CDECL	lfn_decl_ (BYVAL_AS_Parser_PTR P)
	Emitter to generate a declaration line. More...
SUB_CDECL	lfn_class_ (BYVAL_AS_Parser_PTR P)
	Emitter to start parsing of blocks. More...
SUB_CDECL	lfn_func_ (BYVAL_AS_Parser_PTR P)
	Emitter to generate a line for a function name. More...
SUB_CDECL	lfn_include (BYVAL_AS_Parser_PTR P)
	Emitter to import a source file. More...
SUB	init_lfn (BYVAL_AS_EmitterIF_PTR Emi)
	Initialize the FunctionNames EmitterIF. More...

Detailed Description

Emitter to generate the file fb-doc.lfn.

This file contains the emitter SecEmmList, which is the default emitter in mode --list-mode (-l). It's used to generate the file fb-doc.lfn for the Doxygen back-end filter feature.

The emitter 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 fbdoc_emit_lfn.bas.

Function Documentation

FUNCTION_AS_INTEGER startLFN

(

BYREF_AS_STRING

Path

)

Definition at line 19 of file fbdoc_emit_lfn.bas.

Here is the caller graph for this function:

SUB_CDECL lfn_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 / DECLARE). It generates a line for each variable name and sends it (them) to the output stream.

Definition at line 49 of file fbdoc_emit_lfn.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL lfn_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 69 of file fbdoc_emit_lfn.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL lfn_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 84 of file fbdoc_emit_lfn.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL lfn_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 (-r) is given. It checks if the file has been done already. If not, it creates a new Parser and starts the scanning process.

Definition at line 107 of file fbdoc_emit_lfn.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB init_lfn

(

BYVAL_AS_EmitterIF_PTR

Emi

)

Initialize the FunctionNames EmitterIF.

Parameters

Emi	The EmitterIF to initialize

FIXME

Since

0.4.0

Definition at line 122 of file fbdoc_emit_lfn.bas.

Here is the call graph for this function:

Here is the caller graph for this function: