Documentation of the Components
Show all options of the generator and all helper objects sorted by their category.
This edit field gives the path where the documentation should be generated to. The directory should be empty, because a lot of files are generated and all files with the same name are simply overwritten without any warning. If the directory doesn't exist it is created automatically.
Shows a dialog to select the directory where the documentation should be generated to.
If the generator supports it, the name of the finally generated file can be entered here. The appropriate file extension will be added automatically. If the generator doesn't support it, the edit field will be gray.
With this checkbox the special characters to be used inside comments can be changed to be compatible with Javadoc. DelphiDoc uses by default the tilde "~" and brackets, "[" and "]", to create sections and use inline commands to format text. When compatibility is enabled they are changed in the options to the at-sign "@" and normal braces, "(" and ")". When it is disabled it is changed back to the defaults of the program. If the check box is grayed, the options' values are incompatible with both, Javadoc and this program's defaults.
The name or title of the project for which the documentation is generated. Will be inserted in the documentation.
Documentation can be generated as a help on a GUI - Graphical User Interface. For that log files of the GUI have to be generated. JADD's source distribution contains in the subdirectory GUI the file UFormHelp, that can be included in any other Delphi project to create the log files. For each log file another file (same base name, but extension .txt) should be created and contain the help on each component.
For more information please take a look at the manual. JADD's source files also include the files used to generate its help (you are currently looking at it).
Generates documentation as a help of a GUI - Graphical User Interface of a program. The log file of all components first have to generated, take a look at the file
GUI\UFormHelp.pas in the source of this program. The files first have to be selected on the previous page. Specified user documentation will be used, too.
Not all generators support this kind of documentation, currently Windows Help files, PDF files or sets of HTML files and HTML Help can be created with this kind of documentation. Windows Help and HMTL Help will also use the help contexts of the components.
Please see one of the contained components for a more specific help.