fbdoc_main.bas File Reference

The source file with the main function. More...

#include "fbdoc_options.bi"
#include "fbdoc_version.bi"

Include dependency graph for fbdoc_main.bas:

Go to the source code of this file.

Macros
#define	MSG_HELP
	The help message for the command line interface (mode –help (-h)) More...
#define	MSG_WELCOME
	The welcome message, shown when running as a program (mode –file-mode (-f)) More...
#define	MSG_VERSION
	The version information for the command line interface (mode –version (-v)) More...
#define	FBDOC_TARGET   /* "UNIX/LINUX" */
	The target operation system (used in MSG_VERSION, UNIX version here) More...
#define	FBDOC_BINARY   /* PROJ_NAME */
	The name of the binary (used in MSG_HELP, UNIX version here) More...
#define	FBDOC_BINARY   /* PROJ_NAME & ".exe" */
	The name of the binary (used in MSG_HELP, UNIX version here) More...

Functions
*int	main ()
	A dummy function. More...

Detailed Description

The source file with the main function.

This file includes the main function to execute.

Definition in file fbdoc_main.bas.

Macro Definition Documentation

MSG_HELP

#define MSG_HELP

Value:

  /*  _
  "Command line tool for generating documentation from FreeBASIC source code." & NL & NL & _
  "Usage" & NL & _
  "  " & FBDOC_BINARY & " [Options] [file specs]" & NL & NL & _
  "Options:" & NL & _
  " -h (--help)    : print this help text and stop" & NL & _
  " -v (--version) : print version information and stop" & NL & _
  "       none         : file in --> STDOUT" & NL & _
  " -f (--file-mode)   : file in --> file out" & NL & _
  " -g (--geany-mode)  : STDIN --> STDOUT" & NL & _
  " -l (--list-mode)   : Doxgfile inputs --> fbdoc.lfn" & NL & _
  " -s (--syntax-mode) : scan doxygen output, repair syntax highlighting" & NL & _
  " -a (--asterix)     : prepend '* ' in ML comments (gtk-doc style)" & NL & _
  " -c (--cstyle)      : emit real C types" & NL & _
  " -d (--doc-comment) : force documentational comments in listings" & NL & _
  " -e (--emitter)     : specify emitter name" & NL & _
  " -L (--ListFunctionNames) : specify path & name of *.lfn file" & NL & _
  " -o (--outpath)     : specify output directory" & NL & _
  " -r (--recursiv)    : scan input files also in subfolders" & NL & _
  " -t (--tree)        : scan source tree (follow #INCLUDEs)" & NL & _
  "Examples:" & NL & _
  "  " & FBDOC_BINARY & " --geany-mode" & NL & _
  "      Get input from STDIN, prepend a matching comment block, emit to STDOUT" & NL & _
  "      (emits gtk-doc templates for ENUM, UNION, TYPE, SUB, FUNCTION, PROPERTY)" & NL & _
  "  " & FBDOC_BINARY & " -f -t MyProject.bas" & NL & _
  "      Load MyProject.bas from current folder and follow source tree" & NL & _
  "      emit pseudo C code in ../c_src" & NL & _
  "Find detailed description at:" & NL & _
  "  " & PROJ_WEBS & NL */

The help message for the command line interface (mode –help (-h))

Definition at line 13 of file fbdoc_main.bas.

MSG_WELCOME

#define MSG_WELCOME

Value:

  /*  _
  "version " & PROJ_VERS & ", License GPLv3" & NL & _
  "        Copyright (C) 2012-" & PROJ_YEAR & " by " & PROJ_MAIL & NL */

The welcome message, shown when running as a program (mode –file-mode (-f))

Definition at line 16 of file fbdoc_main.bas.

MSG_VERSION

#define MSG_VERSION

Value:

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

The version information for the command line interface (mode –version (-v))

Definition at line 19 of file fbdoc_main.bas.

FBDOC_TARGET

#define FBDOC_TARGET   /* "UNIX/LINUX" */

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

Definition at line 23 of file fbdoc_main.bas.

FBDOC_BINARY [1/2]

#define FBDOC_BINARY   /* PROJ_NAME */

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

Definition at line 29 of file fbdoc_main.bas.

FBDOC_BINARY [2/2]

#define FBDOC_BINARY   /* PROJ_NAME & ".exe" */

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

Definition at line 29 of file fbdoc_main.bas.

Function Documentation

main()

* int main

(

)

A dummy function.

This function is not in FB code. It's necessary to make Doxygen create caller / callee graphs for the function calls in that code. That's why we cover the main code in FB source by a pseudo C function.

Definition at line 41 of file fbdoc_main.bas.

Here is the call graph for this function: