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

Classes
class	EmitterIF
	The emitter interface. More...

Typedefs
typedef Parser	Parser_
	Forward declaration. More...

typedef SUB_CDECL	EmitFunc(BYVAL_AS_Parser__PTR P)
	Function type for EmitterIF to emit a piece of code. More...

typedef Options	Options_
	Forward declaration. More...

typedef SUB_CDECL	TorFunc(BYVAL_AS_Options__PTR O)
	Function type for EmitterIF `CTOR` and `DTOR` More...

typedef EmitterIF *	EmitterIF_PTR
	Doxygen internal (ignore this). More...

Enumerations
enum	EmitterTypes { C_SOURCE , FUNCTION_NAMES , GTK_DOC_TEMPLATES , DOXYGEN_TEMPLATES , SYNTAX_REPAIR , EXTERNAL }
	Enumerators for in-build emitters. More...

Variables
const	SLASH = "/"
	separator for folders (unix version) More...

const	NL = !"\n"
	separator for lines (unix version) More...

const	COMM_END = NL & "'/" & NL
	the end of an FB comment block (in templates) More...

const	TOFIX = "FIXME"
	the text to initialize entry fields (in templates) More...

Detailed Description

Header file for EmitterIF.

This file contains the declaration code for the EmitterIF.

Definition in file fbdoc_emitters.bi.

Typedef Documentation

◆ Parser_

typedef Parser Parser_

Forward declaration.

Definition at line 45 of file fbdoc_emitters.bi.

◆ EmitFunc

typedef SUB_CDECL EmitFunc(BYVAL_AS_Parser__PTR P)

Function type for EmitterIF to emit a piece of code.

Parameters

P	The parser calling this handler

Definition at line 49 of file fbdoc_emitters.bi.

◆ Options_

typedef Options Options_

Forward declaration.

Definition at line 52 of file fbdoc_emitters.bi.

◆ TorFunc

typedef SUB_CDECL TorFunc(BYVAL_AS_Options__PTR O)

Function type for EmitterIF CTOR and DTOR

Parameters

O	The Options calling the `CTOR` or `DTOR`

Definition at line 56 of file fbdoc_emitters.bi.

◆ EmitterIF_PTR

typedef EmitterIF* EmitterIF_PTR

Doxygen internal (ignore this).

Definition at line 59 of file fbdoc_emitters.bi.

Enumeration Type Documentation

◆ EmitterTypes

enum EmitterTypes

Enumerators for in-build emitters.

By default these five emitters are available in fbdoc, the sixth entry is for external plugins. The enumerators are used for default settings in the Options class. The user can choose the emitter by option –emitter (-e).

Enumerator
C_SOURCE	emit pseudo C source (modes none (default) and –file-mode (-f))
FUNCTION_NAMES	emit a list of function names (mode –list-mode (-l))
GTK_DOC_TEMPLATES	emit templates for gtk-doc (mode –geany-mode (-g))
DOXYGEN_TEMPLATES	emit templates for Doxygen (mode –geany-mode (-g))
SYNTAX_REPAIR	fix syntax highlighting of Doxygen listings (mode –syntax-mode (-s))
EXTERNAL	external emitter loaded as plugin

Definition at line 35 of file fbdoc_emitters.bi.

Variable Documentation

◆ SLASH

const SLASH = "/"

separator for folders (unix version)

Definition at line 11 of file fbdoc_emitters.bi.

◆ NL

const NL = !"\n"

separator for lines (unix version)

Definition at line 12 of file fbdoc_emitters.bi.

◆ COMM_END

const COMM_END = NL & "'/" & NL

the end of an FB comment block (in templates)

Definition at line 23 of file fbdoc_emitters.bi.

◆ TOFIX

const TOFIX = "FIXME"

the text to initialize entry fields (in templates)

Definition at line 24 of file fbdoc_emitters.bi.

Classes

Typedefs

Enumerations

Variables