| 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
Macros
fb-doc.bi File Reference

Header for the main source file. More...

`#include "fb-doc_emitters.bi"`
`#include "fb-doc_parser.bi"`
`#include "fb-doc_options.bi"`
Include dependency graph for fb-doc.bi:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Macros

#define | MSG_HELP
| The help message for the command line interface (option –help) More...
#define | MSG_WELCOME
| The welcome message, shown when running as a program (option –fileoutput) More...
#define | MSG_VERSION
| The version information for the command line interface (option –version) More...
#define | FBDOC_TARGET "UNIX/LINUX"
| The target operation system (used in MSG_VERSION, UNIX version here) More...
#define | FBDOC_BINARY "./" & PROG_NAME
| The name of the binary (used in MSG_HELP, UNIX version here) More...
#define | SLASH "/"
| The operation system specific slash character (UNIX version here) More...
#define | ERROUT(_T_)
| Emit a message to console. More...

## Detailed Description

Header for the main source file.

This file contains #DEFINEs for the user communication at the command prompt and adjusts some operation system specific settings. It also includes the headers for the modules.

Definition in file fb-doc.bi.

## Macro Definition Documentation

#define MSG_HELP

Value:
_ /* making a C comment here makes the Doxygen lexer interpret this as Value:
"Command line tool for generating documentation in FreeBasic source code." & NL & NL & _
"Usage" & NL & _
" " & FBDOC_BINARY & " [Options]" & NL & NL & _
"Options:" & NL & _
" -h (--help): print this help text and stop" & NL & _
" -v (--version): print version information and stop" & NL & _
" -a (--asterix): emit leading '* ' characters (gtk-doc style)" & NL & _
" -c (--cstyle): emit real C types" & NL & _
" -e (--emitter): specify emitter name" & NL & _
" -f (--fileoutput): write output in files" & NL & _
" -g (--geany): run in geany mode (read from STDIN, export on STDOUT)" & NL & _
" -l (--list): generate fb-doc.lfn file" & NL & _
" -p (--path): specify output directory" & NL & _
" -r (--recursiv): scan input files in subfolders" & NL & _
" -t (--tree): scan source tree (follow #INCLUDEs)" & NL & _
"Example:" & NL & _
" " & FBDOC_BINARY & " -f" & NL & _
" Scan current folder for .bas and .bi files and" & NL & _
" create pseudo C code in ../doc/c_src" & NL & _
" " & FBDOC_BINARY & " --geany" & NL & _
" Get input from STDIN and send a matching comment block to STDOUT" & NL & _
" (for ENUM, UNION, TYPE, SUB, FUNCTION, PROPERTY)" & NL & _
"For details see file 'ReadMe.txt' or visit:" & NL & _
" http://www.freebasic-portal.de/downloads/ressourcencompiler/fb-doc-229.html (de)" & NL & _
" http://www.freebasic.net/forum/viewtopic.php?f=8&t=19810 (en)" & NL 'end of C comment */

The help message for the command line interface (option –help)

Definition at line 11 of file fb-doc.bi.

#define MSG_WELCOME

Value:
_ /*
" This is " & PROG_NAME & " version " & PROG_VERS & ", License GPLv3" & NL & _
" Copyright (C) 2012-2013 by Thomas.Freiherr{ at }gmx[ dot ]net" & NL '*/

The welcome message, shown when running as a program (option –fileoutput)

Definition at line 39 of file fb-doc.bi.

#define MSG_VERSION

Value:
_ /*
" Compiled: " & __DATE__ & ", " & __TIME__ & " for " & _
FBDOC_TARGET & ". (" & __FB_SIGNATURE__ & ")" & NL '*/

The version information for the command line interface (option –version)

Definition at line 44 of file fb-doc.bi.

#define FBDOC_TARGET "UNIX/LINUX"

The target operation system (used in MSG_VERSION, UNIX version here)

Definition at line 50 of file fb-doc.bi.

#define FBDOC_BINARY "./" & PROG_NAME

The name of the binary (used in MSG_HELP, UNIX version here)

Definition at line 52 of file fb-doc.bi.

#define SLASH "/"

The operation system specific slash character (UNIX version here)

Definition at line 54 of file fb-doc.bi.

#define ERROUT | ( |  | _T_) |  |

Value:
_ /*
SCOPE : _
VAR fnr = FREEFILE : _
IF 0 = OPEN ERR (AS #fnr) THEN : _
PRINT #fnr, PROG_NAME & ": " & _T_ : _
CLOSE #fnr : _
END IF : _
END SCOPE '*/

Emit a message to console.

Definition at line 64 of file fb-doc.bi.