wizard.txt

DelphiDoc is a program for automatic generation of documentation on a Delphi-Project. At the momen

This is only the help on the GUI components of the GUI program. For the
documentation take a look ~[linkExtern file:///./Documentation/index.html in 
the sub-directory Documentation] that should accompany this program or go
to ~[linkExtern http://delphidoc.sourceforge.net/] to read the documentation
of the most current version of this program. For the command-line switches
start the program with the switch "-?".




~page WizardForm30000 Wizard: The Form
~[HelpContext 30000]
This is the form of the wizard. It can show different pages of a wizard.
Itself consists of a group box, that will accommodate the page-specific
controls and three buttons. The "Next" button will finish the currently shown
page and go to the succeeding page. The "Back" button will go to the preceding
page so those settings can be checked and changed. The "Close" button will end
the wizard and close the form.

To get help on the current page, please select one of the page-specific
components and press F1.

Please be aware that the wizard only works for the generators of the old 
internal system, which are going to be obsolete and will finally be deleted when
the last has been converted to the new system. Maybe then a new wizard will be 
created.

~[br]The ~[linkPage ~[add ~[insertVariable ThisPage] 1] first page].



















~page WizardOptionsUseComments31101 Wizard: Use Comments?
~[HelpContext 31101]
This page of the ~[linkPage WizardForm30000 wizard] allows to specify if
comments should be used. This can be separately defined for files and
identifiers.
~[br]The ~[linkPage ~[add ~[insertVariable ThisPage] 1] next page].


~page WizardOptionsCommentPositions31102 Wizard: Where to find the Comments?
~[HelpContext 31102]
This page of the ~[linkPage WizardForm30000 wizard] allows to specify where to
find the comments. For files always the first comment is used, but it can be
specified to start the search after the first statement (for instance to skip
legal comments). For identifiers can be defined if the comments should be
extracted at the forward declarations (for functions and sometimes classes) or
at the real positions. To make it simpler it can be defined that both positions
should be tried, so only one position takes the precedence.
~[br]The ~[linkPage ~[add ~[insertVariable ThisPage] -1] previous page].
~[br]The ~[linkPage ~[add ~[insertVariable ThisPage] 1] next page].


~page WizardOptionsCommentStars31103 Wizard: Stars in Comments
~[HelpContext 31103]
This page of the ~[linkPage WizardForm30000 wizard] allows to specify if only
comments with a leading star should be used, and also if such leading and 
trailing stars should be stripped from the comments.
~[br]The ~[linkPage ~[add ~[insertVariable ThisPage] -1] previous page].
~[br]The ~[linkPage ~[add ~[insertVariable ThisPage] 1] next page].


~page WizardOptionsParseComments31104 Wizard: Parse the Comments
~[HelpContext 31104]
This page of the ~[linkPage WizardForm30000 wizard] allows to specify if the
comments should be parsed. ~[em DelphiDoc] allows several sections and commands
to create better documentations for files and identifiers. But if the parsed
source code isn't commented in this way, it may be better to disable the
parsing, the comment will then be entered unchanged in the documentation.~[p]

An option to keep the line breaks is also available. If this is not set, the
text will be realigned to use the whole available width of the document.
~[br]The ~[linkPage ~[add ~[insertVariable ThisPage] -1] previous page].
~[br]The ~[linkPage ~[add ~[insertVariable ThisPage] 1] next page].


~page WizardOptionsCommentOptions31105 Wizard: Options of the Comments
~[HelpContext 31105]
This page of the ~[linkPage WizardForm30000 wizard] allows to specify some
options for the comments and is the last page for the options of the generator,
unless the generated format is HTML.
~[br]The ~[linkPage ~[add ~[insertVariable ThisPage] -1] previous page].
~[br]The ~[linkPage ~[add ~[insertVariable ThisPage] 1] next page].



~page WizardOptionsUseRawHTML31106 Wizard: Comments in raw HTML
~[HelpContext 31106]
This page of the ~[linkPage WizardForm30000 wizard] allows to specify if raw
HTML tags should just be passed on from the comments into the documentation.
Obviously this only works if the documentation is also generated in a HTML
format. It is the last page for the options of the generator.
~[br]The ~[linkPage ~[add ~[insertVariable ThisPage] -1] previous page].