options.html

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

               only a small set of normal characters, most character have to be
               created by commands or special character sequences. I don't know
               what sequences to use for each character and it may be character
               encoding dependent. So you have here the chance to define them
               yourself.</dd>
       </dl>


    <h3><a name="OptionTICPDFDoc"><code>TICPDFDoc</code></a></h3>
       <dl>
         <dt><a name="TICPDFDoc.UseSansSerifFont">UseSansSerifFont</a></dt>
           <dd>Uses the font Helvetica/Arial instead of Times (New) Roman.</dd>
         <dt><a name="TICPDFDoc.FontSize">FontSize</a></dt>
           <dd>Size of the font to use in points.</dd>
         <dt><a name="TICPDFDoc.LineDistanceScale">LineDistanceScale</a></dt>
           <dd>Factor of the size of the current font to get the distance to
               the next line.</dd>
         <dt><a name="TICPDFDoc.LinkColor">LinkColor</a></dt>
           <dd>Color of links inside the file as RGB integer value,
               format <code>$BBGGRR</code> can be used to enter it
               hexadecimally.</dd>
         <dt><a name="TICPDFDoc.ExternLinkColor">ExternLinkColor</a></dt>
           <dd>Color of links to the Word Wide Web as RGB integer value,
               format <code>$BBGGRR</code> can be used to enter it
               hexadecimally.</dd>
         <dt><a name="TICPDFDoc.FileLinkColor">FileLinkColor</a></dt>
           <dd>Color of links to other files as RGB integer value,
               format <code>$BBGGRR</code> can be used to enter it
               hexadecimally.</dd>
         <dt><a name="TICPDFDoc.StringColor">StringColor</a></dt>
           <dd>Color of string constants as RGB integer value,
               format <code>$BBGGRR</code> can be used to enter it
               hexadecimally.</dd>
         <dt><a name="TICPDFDoc.PageMarkingFont">PageMarkingFont</a></dt>
           <dd>Use the font Courier, Helvetica/Arial or Times (New) Roman when
               printing number of pages etc..</dd>
         <dt><a name="TICPDFDoc.PageMarkingFontSize">PageMarkingFontSize</a></dt>
           <dd>Size of the font to use when printing number of page etc..</dd>
         <dt><a name="TICPDFDoc.PageMarkingFontStyle">PageMarkingFontStyle</a></dt>
           <dd>Style of the font to use when printing number of page etc..</dd>
         <dt><a name="TICPDFDoc.PageWidth">PageWidth</a></dt>
           <dd>Width of the pages in the file in centimeters, default is
               21 centimeters for A4 after ISO 216 (DIN A4).</dd>
         <dt><a name="TICPDFDoc.PageHeight">PageHeight</a></dt>
           <dd>Height of the pages in the file in centimeters, default is
               29.7 centimeters for A4 after ISO 216 (DIN A4).</dd>
         <dt><a name="TICPDFDoc.LeftMargin">LeftMargin</a></dt>
           <dd>Margin on the left of the page, where no text is written.</dd>
         <dt><a name="TICPDFDoc.PaperFormat">PaperFormat</a></dt>
           <dd>The paper format to use (to use a standard paper size) or a
               customized size. There is a good variety of formats available.
               Using the first format, "Customized", allows to use any paper
               size. Default is still A4 after
               <a href="http://en.wikipedia.org/wiki/Paper_size">ISO 216</a>
               (DIN A4). This value is purely calculated, so changing it will
               only change the size of the paper and vice versa. As there are a
               few paper sizes with several names, using one of them might show
               another, for instance setting this option to "ANSI B" or
               "Ledger" will result in it having the value "Tabloid".</dd>
         <dt><a name="TICPDFDoc.LandscapeOrientation">LandscapeOrientation</a></dt>
           <dd>Whether the paper should be used in landscape orientation
               (wider than height) instead of portrait (higher than width)
               This value is also purely calculated, assigning a different
               value will simply swap the dimensions of the paper.</dd>
         <dt><a name="TICPDFDoc.RightMargin">RightMargin</a></dt>
           <dd>Margin on the right of the page, where no text is written.</dd>
         <dt><a name="TICPDFDoc.TopMargin">TopMargin</a></dt>
           <dd>Margin on the top of the page, where no text is written, besides
               the page markings.</dd>
         <dt><a name="TICPDFDoc.BottomMargin">BottomMargin</a></dt>
           <dd>Margin on the bottom of the page, where no text is written,
               besides the page markings.</dd>
         <dt><a name="TICPDFDoc.InterpolateImages">InterpolateImages</a></dt>
           <dd>Whether images should be shown interpolated (smoother) by the
               viewer when showing.</dd>
         <dt><a name="TICPDFDoc.MaxImageScale">MaxImageScale</a></dt>
           <dd>The maximimum zoom/scale factor of images in the PDF file.</dd>
         <dt><a name="TICPDFDoc.DisablePDFCompression">DisablePDFCompression</a></dt>
           <dd>Disables compression of the PDF file.<br>
               Documentation of the Delphi 7 Sources:
               <code>693MB</code> (compressed) and
               <code>1181MB</code> (not compressed).</dd>
         <dt><a name="TICPDFDoc.FileName">FileName</a></dt>
           <dd>The name of the PDF file to create in the directory (i.e.
               without path).</dd>
         <dt><a name="TICPDFDoc.TableOfContentsDetailLevel">TableOfContentsDetailLevel</a></dt>
           <dd>To what sub-level topics will be listed in the table of
               contents. So if you think it is too long, try removing the
               individual members/variables etc. by setting it to 3.</dd>
         <dt><a name="TICPDFDoc.GenerateHelpContextDestinations">GenerateHelpContextDestinations</a></dt>
           <dd>Whether additional Named Destinations should be generated for
               the help contexts. These can be used to show directly the topic
               of the help context without an additional lookup for the real
               internal name. The format of the names is "HC%d". As a result
               the PDF file will grow slightly in size.</dd>
         <dt><a name="TICPDFDoc.DiagramsDirectlyAsPDF">DiagramsDirectlyAsPDF</a></dt>
           <dd>Whether diagrams should be drawn directly via PDF commands as
               vector graphic instead of being included as an image. This is
               the default and preferred. Sometimes in these diagrams the text
               might slightly exceed the boxes they are in, but that and the
               reason for that, that only the three PDF fonts are available to
               draw the texts, is their only fault, their advantages are
               numerous: As vectors graphics they are freely scalable like the
               PDF file itself and therefore look much better if viewed at a
               not-optimal scaling factor. Their text is real text and can be
               searched and selected (although that is somewhat tricky as all
               the texts are links). The inclusion of the diagrams is much
               faster - PNG compression takes long on huge images - for vector
               graphics the number of operations increase much less than the
               image size. And finally the resulting PDF file will also be
               smaller (at least if compression of the PDF file is enabled, see
               option "DisablePDFCompression").</dd>
       </dl>
















    <h3><a name="OptionTDocumentDoc"><code>TDocumentDoc</code></a></h3>
       <dl>
         <dt><a name="TDocumentDoc.GenerateFileTreeFiles">GenerateFileTreeFiles</a></dt>
           <dd>If the files showing the inter-dependence between the files
               should be generated. Xfig and WMF files can be generated. By
               default both will be generated, you can disable the formats with
               GenerateXFigFiles and/or GenerateWMFFiles.</dd>
         <dt><a name="TDocumentDoc.GenerateClassesTreeFiles">GenerateClassesTreeFiles</a></dt>
           <dd>If the files showing the inheritance tree of classes and
               interfaces should be generated. Xfig and WMF files can be
               generated. By default both will be generated, you can disable
               the formats with GenerateXFigFiles and/or GenerateWMFFiles.</dd>
         <dt><a name="TDocumentDoc.GenerateXFigFiles">GenerateXFigFiles</a></dt>
           <dd>If Xfig files should be generated showing the inter-dependence
               between the files or the inheritance tree of classes and
               interfaces.</dd>
         <dt><a name="TDocumentDoc.GenerateWMFFiles">GenerateWMFFiles</a></dt>
           <dd>If WMF files should be generated showing the inter-dependence
               between the files or the inheritance tree of classes and
               interfaces. WMF is a windows standard graphic format and can be
               inserted in most office programs.</dd>
       </dl>


    <h3><a name="OptionTCommentDoc"><code>TCommentDoc</code></a></h3>
       <dl>
         <dt><a name="TCommentDoc.KeepLineBreaksInComments">KeepLineBreaksInComments</a></dt>
           <dd>Inserts a line break at each line break in the source code at
               the comment.</dd>
         <dt><a name="TCommentDoc.ParameterListIfUncommented">ParameterListIfUncommented</a></dt>
           <dd>Whether a list for the documentation of the parameters should be
               created even if no one has been commented.</dd>
         <dt><a name="TCommentDoc.ResultIfUncommented">ResultIfUncommented</a></dt>
           <dd>Whether an entry for the result of a function should be created
               even if it is not commented.</dd>
         <dt><a name="TCommentDoc.FilterCommentSections">FilterCommentSections</a></dt>
           <dd>What sections of comments should be completely ignored.</dd>
       </dl>


    <h3><a name="OptionTFormatCommentDoc"><code>TFormatCommentDoc</code></a></h3>
       <dl>
         <dt><a name="TFormatCommentDoc.MinLongFunctionLines">MinLongFunctionLines</a></dt>
           <dd>The minimum size (number of lines) of the body of functions to
               be reported as long functions. All functions using more lines in
               its body will be reported with their size in a list in the
               documentation.</dd>
         <dt><a name="TFormatCommentDoc.ParamNamesAsSections">ParamNamesAsSections</a></dt>
           <dd>If comments of uncommented parameters should be searched in
               sections with the names of the parameters. This is only done if
               the parameter name does not equal any section name.</dd>
         <dt><a name="TFormatCommentDoc.IdentifierSectionsFilter">IdentifierSectionsFilter</a></dt>
           <dd>Filter some sections of the documentation of an identifier.</dd>
         <dt><a name="TFormatCommentDoc.FileSectionsFilter">FileSectionsFilter</a></dt>
           <dd>Filter some sections of the documentation of a file.</dd>
         <dt><a name="TFormatCommentDoc.DocumentationSectionsFilter">DocumentationSectionsFilter</a></dt>
           <dd>Filter some sections of the documentation (mostly lists).</dd>
       </dl>




    <h3><a name="OptionTBaseHTMLDoc"><code>TBaseHTMLDoc</code></a></h3>
       <dl>
         <dt><a name="TBaseHTMLDoc.DontOverrideCSSFile">DontOverrideCSSFile</a></dt>
           <dd>Creates the CSS file only if it does not exist yet.</dd>
         <dt><a name="TBaseHTMLDoc.TextHeaderFile">TextHeaderFile</a></dt>
           <dd>The file to insert instead of the default text at the beginning
               of each HTML file. The texts <code>&lt;topic&gt;</code>,
               <code>&lt;keywords&gt;</code>, <code>&lt;mainpath&gt;</code> and
               <code>&lt;encoding&gt;</code> will be replaced with the actual
               values, case does matter.
               <code>&lt;topic&gt;</code> will be replaced with the title of
               the page, <code>&lt;keywords&gt;</code> with all key words of
               the page and <code>&lt;mainpath&gt;</code> with the path to the
               main directory of the documentation, in most cases "" but may
               also be "../" or "../../", can be used for instance to link to
               the common CSS file. <code>&lt;encoding&gt;</code> will be
               replaced with the character enconding as specified with the
               option "CharacterEncoding".</dd>
         <dt><a name="TBaseHTMLDoc.TextFooterFile">TextFooterFile</a></dt>
           <dd>The file to insert instead of the default text at the end of
               each HTML-file.</dd>
         <dt><a name="TBaseHTMLDoc.CharacterEncoding">CharacterEncoding</a></dt>