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

Emitter for gtk-doc templates. More...

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

Go to the source code of this file.

## Functions

SUB_CDECL | gtk_emit_Name (BYVAL_AS_Parser_PTR P)
| Emitter to generate a name line. More...
SUB_CDECL | gtk_defi_ (BYVAL_AS_Parser_PTR P)
| Emitter to generate a macro template. More...
SUB_CDECL | gtk_decl_ (BYVAL_AS_Parser_PTR P)
| Emitter to generate a template for a declaration. More...
SUB_CDECL | gtk_func_ (BYVAL_AS_Parser_PTR P)
| Emitter to generate a template for a function. More...
SUB_CDECL | gtk_emitBlockNames (BYVAL_AS_Parser_PTR P)
| Emitter to generate a line for a block entry. More...
SUB_CDECL | gtk_Block (BYVAL_AS_Parser_PTR P)
| Emitter to generate templates for blocks. More...
SUB_CDECL | gtk_empty (BYVAL_AS_Parser_PTR P)
| Emitter for an empty Geany block. More...

## Variables

const VAR | SINCE = NL & NL & "Since: 0.0"
| text added at each block end More...
const VAR | GTK_START = "/'* "
| the start of a comment block More...
const VAR | GTK_END = NL &
| the end of a comment block More...

## Detailed Description

Emitter for gtk-doc templates.

This file contains the emitter for gtk-doc templates. The emitter is designed to create documentation comment blocks for the gtk-doc back-and and it's designed to be used in Geany mode (see section Gtk-doc for an example).

The emitter returns all original source code. Relevant lines (or code blocks) get prepended by a multi line block of documentation. This works for SUBs/FUNCTIONs, TYPE, UNION and ENUM blocks and #DEFINEs / #MACROs.

The first line of the comment block contains the name of the construct, appended by a colon. Then the members are listed with a leading @ character (parameters in case of a SUB / FUNCTION or member variables in case of a block). The block ends by a FIXME text and a line with a since keyword.

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

Definition in file fb-doc_emit_gtk.bas.

## Function Documentation

SUB_CDECL gtk_emit_Name | ( | BYVAL_AS_Parser_PTR | P) |  |

Emitter to generate a name line.

Parameters

  P | the parser calling this emitter

Generate a name for a gtk-doc template. Used in lists (parameters or variable declarations) or blocks (ENUM, TYPE, UNION). It generates a line to document the variable and sends it to the output stream.

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

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL gtk_defi_ | ( | BYVAL_AS_Parser_PTR | P) |  |

Emitter to generate a macro template.

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 59 of file fb-doc_emit_gtk.bas.

Here is the call graph for this function:

SUB_CDECL gtk_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 75 of file fb-doc_emit_gtk.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL gtk_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 104 of file fb-doc_emit_gtk.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL gtk_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 132 of file fb-doc_emit_gtk.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL gtk_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 157 of file fb-doc_emit_gtk.bas.

Here is the call graph for this function:

Here is the caller graph for this function:

SUB_CDECL gtk_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 183 of file fb-doc_emit_gtk.bas.

Here is the caller graph for this function:

## Variable Documentation

const VAR SINCE = NL & NL & "Since: 0.0"

text added at each block end

Definition at line 28 of file fb-doc_emit_gtk.bas.

const VAR GTK_START = "/'* "

the start of a comment block

Definition at line 29 of file fb-doc_emit_gtk.bas.

const VAR GTK_END = NL &

the end of a comment block

Definition at line 30 of file fb-doc_emit_gtk.bas.