SourceForge.net Logo Homepage: http://delphidoc.sourceforge.net/
Project-Page: http://sourceforge.net/projects/delphidoc/


Click component for help:
Main Form Page Acquire Parsed Data Page Load and Save Parsed Data Page Parsing Files Main Page Select Files to Parse Page Exclude Files from Parsing Page Select Library Files Page Compiler Options Page Load Project to Parse Page Parse Files Page Messages after Parsing Page Unknown Identifiers Page Show Source Code Page Keep and Select Parsed Data Page Generate Documentation Main Page Select the Generator Page Select the Extractor of Comments Page Select the Evaluator of Texts Page Localization Page User Documentation Page Generate the Documentation Page Status Text of Generator Page Messages of Generation Page Select log files of GUIs Page Generate Help on a GUI Page Create Diagrams of Classes and Files Page Compare Sets of Parsed Data Page Program Options Tree View Splitter Previous and Next Previous and Next Previous and Next Status Bar Menu File Menu View Menu Help Edit Path of Documentation File Name of Documentation Name of the Project No specific Help Generate Documentation Edit Path of Documentation Browse Directory of Documentation Name of the Project File Name of Documentation Javadoc compatibility Edit all Options By Category Page to generate Help on a GUI Image of the Window

Documentation of the Components

Edit all Options By Category

Show all options of the generator and all helper objects sorted by their category.
top

Edit Path of Documentation

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.
top

Browse Directory of Documentation

Shows a dialog to select the directory where the documentation should be generated to.
top

File Name of Documentation

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.
top

Javadoc compatibility

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.
top

Name of the Project

The name or title of the project for which the documentation is generated. Will be inserted in the documentation.
top

Page to generate Help on a GUI

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).

top

Generate Documentation

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.

top

No specific Help

Please see one of the contained components for a more specific help.
top