| 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
fb-doc.bi
Go to the documentation of this file.
1 /** \file fb-doc.bi
2 \brief Header for the main source file
3
4 This file contains \#DEFINEs for the user communication at the
5 command prompt and adjusts some operation system specific settings.
6 It also includes the headers for the modules.
7
8 */
9
10 /** \brief The help message for the command line interface (option \em --help) */
11 #define MSG_HELP _ /* making a C comment here makes the Doxygen lexer interpret this as Value:
12 "Command line tool for generating documentation in FreeBasic source code." & NL & NL & _
13 "Usage" & NL & _
14 " " & FBDOC_BINARY & " [Options]" & NL & NL & _
15 "Options:" & NL & _
16 " -h (--help): print this help text and stop" & NL & _
17 " -v (--version): print version information and stop" & NL & _
18 " -a (--asterix): emit leading '* ' characters (gtk-doc style)" & NL & _
19 " -c (--cstyle): emit real C types" & NL & _
20 " -e (--emitter): specify emitter name" & NL & _
21 " -f (--fileoutput): write output in files" & NL & _
22 " -g (--geany): run in geany mode (read from STDIN, export on STDOUT)" & NL & _
23 " -l (--list): generate fb-doc.lfn file" & NL & _
24 " -p (--path): specify output directory" & NL & _
25 " -r (--recursiv): scan input files in subfolders" & NL & _
26 " -t (--tree): scan source tree (follow #INCLUDEs)" & NL & _
27 "Example:" & NL & _
28 " " & FBDOC_BINARY & " -f" & NL & _
29 " Scan current folder for .bas and .bi files and" & NL & _
30 " create pseudo C code in ../doc/c_src" & NL & _
31 " " & FBDOC_BINARY & " --geany" & NL & _
32 " Get input from STDIN and send a matching comment block to STDOUT" & NL & _
33 " (for ENUM, UNION, TYPE, SUB, FUNCTION, PROPERTY)" & NL & _
34 "For details see file 'ReadMe.txt' or visit:" & NL & _
35 " http://www.freebasic-portal.de/downloads/ressourcencompiler/fb-doc-229.html (de)" & NL & _
36 " http://www.freebasic.net/forum/viewtopic.php?f=8&t=19810 (en)" & NL 'end of C comment */
37
38 /** \brief The welcome message, shown when running as a program (option \em --fileoutput) */
39 #define MSG_WELCOME _ /*
40 " This is " & PROG_NAME & " version " & PROG_VERS & ", License GPLv3" & NL & _
41 " Copyright (C) 2012-2013 by Thomas.Freiherr{ at }gmx[ dot ]net" & NL '*/
42
43 /** \brief The version information for the command line interface (option \em --version) */
44 #define MSG_VERSION _ /*
45 " Compiled: " & __DATE__ & ", " & __TIME__ & " for " & _
46 FBDOC_TARGET & ". (" & __FB_SIGNATURE__ & ")" & NL '*/
47
48
49 /** \brief The target operation system (used in \ref MSG_VERSION, UNIX version here) */
50 #define FBDOC_TARGET "UNIX/LINUX"
51 /** \brief The name of the binary (used in \ref MSG_HELP, UNIX version here) */
52 #define FBDOC_BINARY "./" & PROG_NAME
53 /** \brief The operation system specific slash character (UNIX version here) */
54 #define SLASH "/"
55
56 /*
57 #define FBDOC_TARGET "win/dos"
58 #define FBDOC_BINARY PROG_NAME & ".exe"
59 #define SLASH "\"
60 */
61
62
63 /** \brief Emit a message to console */
64 #define ERROUT(_T_) _ /*
65 SCOPE : _
66 VAR fnr = FREEFILE : _
67 IF 0 = OPEN ERR (AS #fnr) THEN : _
68 PRINT #fnr, PROG_NAME & ": " & _T_ : _
69 CLOSE #fnr : _
70 END IF : _
71 END SCOPE '*/
72
73 #include "fb-doc_emitters.bi"
74 #include "fb-doc_parser.bi"
75 #include "fb-doc_options.bi"
76