(This is a pseudo call with empty parameter list, fbdoc doesn't support OVERLOADed functions yet.) When a symbol found in a function body matches an entry in this file, a function call gets generated in the output stream. Since the symbol may be defined in an other file in the source tree and fbdoc operates on a single file only, the names of the functions in all source files get read from an external file. fbdoc needs further information to determine the correct type and to make the decision if to function call should generated in the output stream for that word. If such a word is a symbol (no keyword), it can either be an array or a function call. To generate those function calls in the intermediate format, fbdoc checks the words before brackets in a function body. In order to generate caller / callee graphs by Doxygen, the output must contain the function calls in the function bodies. At this moment, fbdoc doesn't know about function declarations in the other source files. Those names are used to generate calls in function bodies in the pseudo C intermediate syntax for Doxygen back end.īackground: When fbdoc runs as a Doxygen filter (default mode), it gets called for a single input file and pipes output to STDOUT. ", but no !"\\c" is allowed, so be careful when editing the file on non-LINUX systems.) The lines are separated by new line characters. Entries for member functions contain the class name and the function name, separated by a dot. The file contains a comment in the first line, followed by list of function names, one name per line. The file usually gets generated by fbdoc in run mode -list-mode (-l) with its default emitter FunctionNames, but editing manualy by any text editor is also possible. It's used by emitter C_Source in order to generate caller / callee graphs and it's located in the Doxygen folder near the configuration file Doxyfile. So fbdoc contains just a minimal set of syntax checks, it relys on input previously validated by the FB compiler.
DOXYGEN MULTIPLE SOURCE DIRECTORIES CODE
Usually the documentation gets done after the code has been checked. It doesn't evaluate all the code, just documentation related constructs get sent to the related emitter functions.įbdoc is designed to operate on error-free source code. The Parser is designed to operate on this files. The standard input of fbdoc is FreeBASIC source code, stored in files with the suffix *.bas or *.bi. The other files are used by specific emitters and run modi. At least one file of the first catagory ( *.bas / *.bi) is used in any case.
Input files get read in all run modes except -geany-mode (-g).
0 kommentar(er)
