📄 options.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head lang="en">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="Content-Language" content="en">
<meta name="author" content="Gerold Veith">
<meta name="description" content="Options of the generators of documentation in JADD - Just Another DelphiDoc, a program for automatic generation of documentation on Delphi source code.">
<meta name="keywords" content="Manual, Help, Options, Generators, generate, Documentation, DelphiDoc, KylixDoc, JADD, Just Another DelphiDoc, Delphi, Kylix, HTML, RTF, TeX, LaTeX, PDF, Portable Document Format, XMI, UML">
<meta name="DC.Language" content="en">
<title>
Options of the Generators in JADD - Just Another DelphiDoc
</title>
</head>
<body lang="en">
<p align=center>
<!-- local -->
<a href="http://sourceforge.net/"><img
src="sflogo.png"
width="210" height="62" border="0" alt="SourceForge.net Logo"
align="right"></a>
<!-- /local -->
<!-- public - -!
<a href="http://sourceforge.net/"><img
src="http://sourceforge.net/sflogo.php?group_id=113456&type=5"
width="210" height="62" border="0" alt="SourceForge.net Logo"
align="right"></a>
<!- - /public -->
Homepage: <a href="http://delphidoc.sourceforge.net/">http://delphidoc.sourceforge.net/</a><br>
Project-Page: <a href="http://sourceforge.net/projects/delphidoc/">http://sourceforge.net/projects/delphidoc/</a><br>
</p>
<br clear="all">
<h1>JADD - Just Another <em>DelphiDoc</em></h1>
Back to <a href="index.html">the main page</a> or
<a href="manual.html">the manual.</a>
<h2>Table of Contents</h2>
<ul>
<li><a href="#GeneratorOptions">General Note on the Options</a></li>
<li>Options of the Generators
<ul>
<li><code><a href="#OptionTMakeDoc">TMakeDoc</a></code></li>
<li><code> <a href="#OptionTDiagramCreator">TDiagramCreator</a></code></li>
<li><code> <a href="#OptionTExtractSourceDoc">TExtractSourceDoc</a></code></li>
<li><code> <a href="#OptionTSaveDataDoc">TSaveDataDoc</a></code></li>
<li><code> <a href="#OptionTSaveTranslation">TSaveTranslation</a></code></li>
<li><code> <a href="#OptionTUMLXMIExportDoc">TUMLXMIExportDoc</a></code></li>
<li><code> <a href="#OptionTICDocumentDoc">TICDocumentDoc</a></code></li>
<li><code> <a href="#OptionTICCommentDoc">TICCommentDoc</a></code></li>
<li><code> <a href="#OptionTICBaseHTMLDoc">TICBaseHTMLDoc</a></code></li>
<li><code> TICHTMLDoc</code></li>
<li><code> <a href="#OptionTICHTMLHelpDoc">TICHTMLHelpDoc</a></code></li>
<li><code> <a href="#OptionTICWinHelpDoc">TICWinHelpDoc</a></code></li>
<li><code> <a href="#OptionTICLaTeXDoc">TICLaTeXDoc</a></code></li>
<li><code> <a href="#OptionTICPDFDoc">TICPDFDoc</a></code></li>
<li><code> TOldDoc</code></li>
<li><code> <a href="#OptionTDocumentDoc">TDocumentDoc</a></code></li>
<li><code> <a href="#OptionTCommentDoc">TCommentDoc</a></code></li>
<li><code> <a href="#OptionTFormatCommentDoc">TFormatCommentDoc</a></code></li>
<li><code> <a href="#OptionTBaseHTMLDoc">TBaseHTMLDoc</a></code></li>
<li><code> THTMLDoc</code></li>
<li><code> <a href="#OptionTHTMLHelpDoc">THTMLHelpDoc</a></code></li>
<li><code> <a href="#OptionTWinHelpDoc">TWinHelpDoc</a></code></li>
<li><code> <a href="#OptionTLaTeXDoc">TLaTeXDoc</a></code></li>
<li><code> <a href="#OptionTBasePDFDoc">TBasePDFDoc</a></code></li>
<li><code> <a href="#OptionTPDFDoc">TPDFDoc</a></code></li>
</ul>
</li>
<li>Options of the Extractors of Comments
<ul>
<li><code>TCommentExtractor</code></li>
<li><code> <a href="#OptionTSectionExtractor">TSectionExtractor</a></code></li>
<li><code> <a href="#OptionTSourceCommentExtractor">TSourceCommentExtractor</a></code></li>
</ul>
</li>
<li>Options of the Evaluators
<ul>
<li><code>TCommentEvaluator</code></li>
<li><code> <a href="#OptionTJADDCommentEvaluator">TJADDCommentEvaluator</a></code></li>
</ul>
</li>
<li>Options of the Parsers of Comments
<ul>
<li><code><a href="#OptionTCommentScanner">TCommentScanner</a></code></li>
<li><code> <a href="#OptionTJaddCommentData">TJaddCommentData</a></code></li>
</ul>
</li>
<li>Options of the Builder of the Documentation
<ul>
<li><code>...</code></li>
<li><code> <a href="#OptionTICIdentDocBuilder">TICIdentDocBuilder</a></code></li>
</ul>
</li>
<li>Options for the Creation of a Help on a GUI
<ul>
<li><code>TGUIHelpReader</code></li>
<li><code> <a href="#OptionTJADDGUIHelpReader">TJADDGUIHelpReader</a></code></li>
</ul>
</li>
<li><i>Options</i> to localize the Documentation
<ul>
<li><code><a href="#OptionTEditDocumentationTexts">TEditDocumentationTexts</a></code></li>
</ul>
</li>
</ul>
<h2><a name="GeneratorOptions">General Note on the Options</a></h2>
<p>When generating the documentation several options may be set to
specify how it should be generated. The lists of all options of all
generators follow in this file.</p>
<p>Remember, these options can be set by reading them from an ini file or
directly from the file <code>DelphiDoc.ini</code> in the same
directory as the executable file. They can also be set at the command
line, in Windows for instance by a creating a shortcut (link) and
adding the parameters. For example
<code>-o AutoLaunchDocumentation=true</code> will launch the
documentation after it has been generated.</p>
<p>The generators are in a hierarchy, every generator also contains the
options of its more general ancestors. Generators with common
ancestors can also share the values of the common options. So be sure
to take a look at all available options of the generator of your
choice.</p>
<p>These lists of options may grow anytime. It's the simplest way to
add features and to make the generator suitable for the different
requirements of different people in different situations.</p>
<h2>Options of the Generators</h2>
<h3><a name="OptionTMakeDoc"><code>TMakeDoc</code></a></h3>
<dl>
<dt><a name="TMakeDoc.DestPath">DestPath</a></dt>
<dd>The directory, where the documentation should be generated
to.</dd>
<dt><a name="TMakeDoc.ProjectName">ProjectName</a></dt>
<dd>The name of the project to be included in the
documentation.</dd>
<dt><a name="TMakeDoc.AutoLaunchDocumentation">AutoLaunchDocumentation</a></dt>
<dd>Whether the generated documentation should be shown/started
after its generation. This does only work in
<code>T(IC)HTMLDoc</code> and <code>T(IC)PDFDoc</code> and also
in <code>T(IC)WinHelpDoc</code> and
<code>T(IC)HTMLHelpDoc</code> if it is automatically compiled.
This won't work with Kylix at all.</dd>
<dt><a name="TMakeDoc.OnlyPublicIdentifiers">OnlyPublicIdentifiers</a></dt>
<dd>Whether only public identifiers should be documented.</dd>
<dt><a name="TMakeDoc.IgnoredPortabilityIssues">IgnoredPortabilityIssues</a></dt>
<dd>Whether identifiers (or files) with these portability issues
should be excluded from the documentation. Include "D", "P",
and/or "L" for <b>d</b>eprecated, <b>p</b>latform or
<b>l</b>ibrary.</dd>
<dt><a name="TMakeDoc.FilterIdentifiersByScope">FilterIdentifiersByScope</a></dt>
<dd>If identifiers with these scopes should be excluded from the
documentation.</dd>
<dt><a name="TMakeDoc.FilterMembersByScope">FilterMembersByScope</a></dt>
<dd>If members with these scopes should be excluded from the
documentation.</dd>
<dt><a name="TMakeDoc.FilterIdentifiersByKind">FilterIdentifiersByKind</a></dt>
<dd>What kinds of identifiers should be excluded from the
documentation.</dd>
<dt><a name="TMakeDoc.FilterClassesByKind">FilterClassesByKind</a></dt>
<dd>What kinds of record-like types should be excluded from the
documentation.</dd>
<dt><a name="TMakeDoc.FilterFunctionsByKind">FilterFunctionsByKind</a></dt>
<dd>What kinds of functions should be excluded from the
documentation.</dd>
<dt><a name="TMakeDoc.FilterMembersByKind">FilterMembersByKind</a></dt>
<dd>What kinds of members should be excluded from the
documentation.</dd>
<dt><a name="TMakeDoc.FilterFilesByName">FilterFilesByName</a></dt>
<dd>A comma-separated list of pascal names of files that should be
excluded from the documentation. The names are the pascal names,
so don't include the file extension. Syntax:
<code>[File[,File]*]</code></dd>
<dt><a name="TMakeDoc.FilterIdentifiersByName">FilterIdentifiersByName</a></dt>
<dd>A comma-separated list of names of identifiers that should be
excluded from the documentation. The access paths to the
identifier can also be specified separated by a dot ".", i.e.
for members the record-like type it is a member of or for all
other identifiers the file, it can also be specified for the
record-like type of a member. Syntax:
<code>[Entry[,Entry]*]</code> with Entry being:
<code>[File.][RecordType.]Identifier</code></dd>
</dl>
<h3><a name="OptionTDiagramCreator"><code>TDiagramCreator</code></a></h3>
<p>The options to define how the diagram looks and what it contains use
the same syntax/semantic as the inline command
<a href="comments.html#icdiagram">~[diagram ]</a>. Please take a look
at its description.</p>
<dl>
<dt><a name="TDiagramCreator.FileName">FileName</a></dt>
<dd>The name of the file to save the image of the diagram of the
classes or files to. The default extension is ".bmp". Also
possible extensions are ".png", ".svg", ".svgz", ".emf", ".wmf",
".jpg" and ".jpeg".</dd>
<dt><a name="TDiagramCreator.LinkMapFileName">LinkMapFileName</a></dt>
<dd>The name of the file to save the link map of the diagram to. If
it an empty string, no link map will be saved. If the file
extension ".txt" is specified (it's also the default extension),
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -