| Programming tools / Source documentation | |
The source documentation structure is based on the well-known Java-doc technique. The generated documentation reflects the structure of your sources; in order to have nicely structured source documentation, you must have a nicely structured source tree.
The source documentation elements are structured as follows (elements in red must be created by hand, while the green color indicates generated files):
First create a file named overview.4gl in the top directory of the project. This file contains the overall description of the project. In that directory, the documentation generator creates the files overview-summary.html, overview-frame.html, allclasses-frame.html, index-all.html, index.html and fgldoc.css .
The documentation generator can scan sub-directories to build the documentation for a whole project; each source directory defines a package. For each directory (i.e. package), the generator creates a package-summary.html and a package-frame.html file. If a file with the name package-info.4gl exists, it will be scanned to complete the package-summary.html file with the package description.
The documentation generator creates a filename .html file for each 4gl source module, seen as a class in the documentation.