Man pages sections > man1 > gbh3

gbh3 - GAMBAS documentation generator for C/C++ components

gbh3(1) User Commands gbh3(1)

NAME

gbh3 - GAMBAS documentation generator for C/C++ components
 

SYNOPSIS

gbh3 [ options] [<sources>]
 

DESCRIPTION

Gambas is a free development environment based on a Basic interpreter with object extensions, like Visual Basic(tm) (but it is NOT a clone!). With Gambas, you can quickly design your program GUI, access MySQL or PostgreSQL databases, pilot KDE applications with DCOP, translate your program into many languages, and so on...
 
gbh3 is a tool to generate GAMBAS online documentation from documentation strings embedded in C/C++ source code of GAMBAS components.
Components written in Gambas can already be documented in-code. This documentation is then stored inside their .info files.
 

OPTIONS

-r, --root <root>
the GAMBAS installation directory
-c, --component <component>
generate help directly in a component '*.help' file
-v, --verbose
be verbose
-V, --version
display version information and exit
-L, --license
display license and exit
-h, --help
display this help and exit
 

USAGE

If <sources> contains directories, they are searched recursively for '*.c' and '*.cpp' files. If <sources> is not specified, the current directory is searched.
 
The extracted help is printed on the standard output, unless the '-c' option is specified.
 

DOCUMENTATION SYNTAX

You may write a Gambas documentation comment like
 

/**G
* Here goes the documentation.
**/
BEGIN_METHOD_VOID(ClassName_MethodName)
/* ... */
END_METHOD
 
or alternatively
 

/**G Class Symbol
* Documenting Class.Symbol
**/
 
Instead of the **/ at the end, you may also write */. Cool, huh?
 
The second syntax can also be used to document the class per se:
 

/**G Class
* Class documentation here
**/
 
The difference between both notations is that the first must immediately precede a BEGIN_{PROPERTY,METHOD,METHOD_VOID) line that defines the symbol to which the documentation refers. The second syntax documents the indicated symbol -- no matter where the comment is.
This is intended to document GB_CONSTANTs or GB_PROPERTY_SELFs which don't have a BEGIN_* line. It can neverthelss be used for any other symbol but NEVER intermix both syntaxes on a single symbol.
The ClassName_MethodName part I call "(implementation) function name". The particular function naming convention shown is not mandatory. The scripts take the function name and look up the corresponding symbol in your GB_DESC[].
 

WARNING

The regular expressions used to filter these comments are somewhat strict. You have to pass the spaces exactly as indicated in the line where your comment text starts, i.e. <space>*<space>text. Also note that Class and Symbol in the second syntax are case sensitive!
Don't reuse method and property implementations (except for synonyms).
As the implementation function name is searched in the GB_DESC[]s in your source file, you may not put the same function into different classes -- or the parser may get confused.
Also, keep the GB_DESC[] in the same source file as the help comment.
 

SYNONYMS

The first match for a function name lookup in a GB_DESC[] is taken as the "primary" implementation of that symbol. That means the help comment will be attched to that symbol. All other symbols which call the same function are considered synonyms and are *automatically* documented with the default sentence: "This is a synonym for <primary-symbol>". DO NOT document them separately using a syntax-2 help block!
 

EXAMPLES

gb.openssl and gb.data are partially documented that way. Digest.Hash() and Digest._call() in gb.openssl show how to deal with synonyms. There the entry for Hash precedes the entry for _call, thus Hash is the primary symbol and _call a synonym.
 
To see a sample .help file (on stdout), you can do at the source tree root:
 

$ gbx3 app/src/gbh3 -- gb.openssl
 

AVAILABILITY

The latest version of Gambas can always be obtained from http://gambas.sf.net.
 
 

REPORTING BUGS

Report bugs to <gambas@users.sourceforge.net>.
 
Copyright© 2002, 2016 Benoit Minisini <gambas@users.sourceforge.net; This manual page written for the Debian project (and can be used by others) by Ian Haywood <ian@haywood.id.au>
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
August 2016 Debian