options.html

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

               the link map will be saved as a <em>DelphiDoc</em> inline
               command <a href="comments.html#icimage">~[image ]</a> to include
               the image of the diagram as a simple image and add the links to
               the classes/files on it. Any other extension will save a HTML
               image map.</dd>
         <dt><a name="TDiagramCreator.ExportImageType">ExportImageType</a></dt>
           <dd>Used to select the format of the image the diagram is exported
               as. By default the format will be selected by the file extension
               of the specified file name. If none was specified the diagram
               will be saved by default as a bitmap. The smallest files
               can be archived by using compressed Scalable Vectors Graphics
               (SVGz), but Portable Network Graphics (PNG) might be more
               compatible and generate the second smallest files.</dd>
         <dt><a name="TDiagramCreator.CharacterEncoding">CharacterEncoding</a></dt>
           <dd>The character encoding of the source code files as it should be
               used for generated SVG images of diagrams.</dd>
         <dt><a name="TDiagramCreator.Option">Option</a></dt>
           <dd>Can be used to set an option for the diagram. This is the same
               as specifying one in the inline command ~[diagram ], only
               without the leading slash "/". Note, that you can only add one
               option at a time, also this option is write-only.</dd>
         <dt><a name="TDiagramCreator.Add">Add</a></dt>
           <dd>Can be used to add files or classes to the diagram. This is the
               same as specifying them in the inline command ~[diagram ], only
               without the leading plus sign "+". Note, that you can only add
               one collection of classes/files at a time, also this option is
               write-only.</dd>
         <dt><a name="TDiagramCreator.Sub">Sub</a></dt>
           <dd>Same as "Add" only remove the files/classes, and of course
               without the leading minus sign "-". This option is
               write-only.</dd>
         <dt><a name="TDiagramCreator.Parameter">Parameter</a></dt>
           <dd>Sends a parameter, that will be used to set "Option", "Add" or
               "Sub". It decides to which option to set it to, by the first
               character, just like in the inline command ~[diagram ]. A
               leading slash "/" makes it an option, a leading minus sign will
               remove files/classes and a leading plaus sign or any other
               character will add files or classes. This option is also
               write-only.</dd>
         <dt><a name="TDiagramCreator.Parameters">Parameters</a></dt>
           <dd>Each parameter will be assigned to "Parameter", parameters are
               separated by one or more spaces. This option can also be read
               again and will return a stirng describing the current diagram
               (and will probably be much longer than the value assigned to
               it).</dd>
       </dl>


    <h3><a name="OptionTExtractSourceDoc"><code>TExtractSourceDoc</code></a></h3>
       <dl>
         <dt><a name="TExtractSourceDoc.IgnorePaths">IgnorePaths</a></dt>
           <dd>If the paths of the files should be ignored and all files saved
               directly in the given directory.</dd>
         <dt><a name="TExtractSourceDoc.AbsolutePaths">AbsolutePaths</a></dt>
           <dd>If always the whole path (without drive if possible) should be
               extracted.</dd>
         <dt><a name="TExtractSourceDoc.AlwaysIncludeDrive">AlwaysIncludeDrive</a></dt>
           <dd>If always a directory for the drive should be created (only if
               <code>AbsolutePaths</code> is true).</dd>
       </dl>


    <h3><a name="OptionTSaveDataDoc"><code>TSaveDataDoc</code></a></h3>
       <dl>
         <dt><a name="TSaveDataDoc.FileName">FileName</a></dt>
           <dd>The name of the file to save the parsed data to. Default
               extension is ".ddd".</dd>
       </dl>



    <h3><a name="OptionTSaveTranslation"><code>TSaveTranslation</code></a></h3>

       <p>This is a pseudo-generator, it does not generate documentation about
          the parsed data!<br>
          Instead it generates a Delphi unit with the current translations of
          the texts that would be used in documentation about parsed Delphi
          code, you might want to edit the unit afterwards. All these options
          have to be specified!</p>

       <dl>
         <dt><a name="TSaveTranslation.LanguageNameEnglish">LanguageNameEnglish</a></dt>
           <dd>The English name of the language the texts have been translated
               into (languages start with a capital letter). It will also be
               used as the base name of the unit and an identifier.</dd>
         <dt><a name="TSaveTranslation.LanguageNameItself">LanguageNameItself</a></dt>
           <dd>The name of the language in the language itself.</dd>
         <dt><a name="TSaveTranslation.LanguageCode">LanguageCode</a></dt>
           <dd>The two (low) letter 639-1 ISO-Code for the language, f.i. "en",
               optionally after an underscore with the geographical region
               (the flavor), f.i. "en_US".</dd>
         <dt><a name="TSaveTranslation.TranslatorName">TranslatorName</a></dt>
           <dd>The name of translator/author to be used for the copyright
               notice.</dd>
         <dt><a name="TSaveTranslation.TranslationBaseLanguage">TranslationBaseLanguage</a></dt>
           <dd>The name of the language the translation was based on. For every
               entry equal to the text in that language a notice will be
               logged.</dd>
       </dl>




    <h3><a name="OptionTUMLXMIExportDoc"><code>TUMLXMIExportDoc</code></a></h3>
       <dl>
         <dt><a name="TUMLXMIExportDoc.TagIndentionPerLevel">TagIndentionPerLevel</a></dt>
           <dd>Indention of enclosed XML-Tags (per level). If you want to read
               the source of XMI file, also for debugging etc., all nested tags
               can be indented. A value of one or two should generate a nice
               and easy (or at least much easier) to read XML source. Use zero
               for no indentation in ordert to create smaller files.</dd>
         <dt><a name="TUMLXMIExportDoc.CharacterEncoding">CharacterEncoding</a></dt>
           <dd>Name of the character encoding to set for the XMI file, for
               example: iso-8859-15, UTF-8, iso-8859-1, windows-1252.</dd>
         <dt><a name="TUMLXMIExportDoc.XMIDTDFile">XMIDTDFile</a></dt>
           <dd>Name/URI of the
               <a href="http://www.w3.org/TR/2004/REC-xml-20040204/">DTD</a>
               file to include in the header of the XMI file. A DTD file
               uml13.dtd will be created if option <code>CreateDTDFile</code>
               is true (by default). <code>uml13.dtd</code> is also the default
               for this option. Globally correct URIs may be better to use, so
               take also a look here:
               <a href="http://www.jeckle.de/xmi/v1.1/uml13.dtd">http://www.jeckle.de/xmi/v1.1/uml13.dtd</a>.
               If the string is empty no DTD-Tag will be generated.</dd>
         <dt><a name="TUMLXMIExportDoc.XMIXSLFile">XMIXSLFile</a></dt>
           <dd>Name/URI of the
               <a href="http://www.w3.org/Style/XSL/">XSL/XSLT</a> file to
               include in the header of the XMI file. A XSL file
               xmi.xsl will be created if option <code>CreateXSLFile</code>
               is true (by default). <code>xmi.xsl</code> is also the default
               for this option. You can create you own XSL/XSLT files to
               generate other formats or view it in a brwoser etc.. If the
               string is empty no xml-stylesheet-Tag will be generated.</dd>
         <dt><a name="TUMLXMIExportDoc.CreateDTDFile">CreateDTDFile</a></dt>
           <dd>If the DTD file for the XMI file should be created with the name
               <code>uml13.dtd</code>.</dd>
         <dt><a name="TUMLXMIExportDoc.CreateXSLFile">CreateXSLFile</a></dt>
           <dd>If a (sample) XSL/XSLT file for the XMI file should be created
               with the name <code>xmi.xsl</code>.</dd>
         <dt><a name="TUMLXMIExportDoc.NoXMIClasses">NoXMIClasses</a></dt>
           <dd>The kind of record-like types not to export as classes
               (only as simple data types). By default records and
               dispatch-interfaces are not exported as classes.</dd>
         <dt><a name="TUMLXMIExportDoc.FileName">FileName</a></dt>
           <dd>The name of the XMI file to create in the directory (i.e.
               without path).</dd>
<!--
         <dt><a name="TUMLXMIExportDoc.ExportAssociations">ExportAssociations</a></dt>
           <dd>If associations should also be exported. If a class has a field
               (or property) of the type of another class they are associated.
               This option is currently disabled.</dd>
-->
       </dl>




    <h3><a name="OptionTICDocumentDoc"><code>TICDocumentDoc</code></a></h3>
       <dl>
         <dt><a name="TICDocumentDoc.GenerateFileTreeFiles">GenerateFileTreeFiles</a></dt>
           <dd>Whether the files showing the inter-dependence between the files
               should be generated. Xfig, WMF and SVG files can be generated.
               By default all three will be generated, you can select the
               formats with GenerateFileAndClassesTreeFormats.</dd>
         <dt><a name="TICDocumentDoc.GenerateClassesTreeFiles">GenerateClassesTreeFiles</a></dt>
           <dd>Whether the files showing the inheritance tree of classes and
               interfaces should be generated. Xfig, EMF and SVG files can be
               generated. By default all three will be generated, you can
               select the formats with GenerateFileAndClassesTreeFormats.</dd>
         <dt><a name="TICDocumentDoc.GenerateFileAndClassesTreeFormats">GenerateFileAndClassesTreeFormats</a></dt>
           <dd>In which file formats the files showing the inter-dependence
               between the files and the inheritance tree of classes and
               interfaces should be generated. The
               <a href="http://www.xfig.org/">Xfig</a> (Figures under X),
               <a href="http://msdn2.microsoft.com/en-us/library/cc215212.aspx">EMF</a>
               (Enhanced Windows Meta File) and
               <a href="http://www.w3.org/TR/SVG/">SVG</a> (Scalable Vector
               Graphics) formats are available.</dd>
         <dt><a name="TICDocumentDoc.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="TICDocumentDoc.GenerateHelpContextIniFile">GenerateHelpContextIniFile</a></dt>
           <dd>Whether an ini file, "HelpContexts.ini", mapping the help
               contexts to their destinations should be generated. All values
               are in the section "HelpContexts", the names are the number of
               the help contexts and the values are the destinations. The
               format and meaning of the destinations depend on the generated
               format.</dd>
         <dt><a name="TICDocumentDoc.GenerateHelpContextMappingFile">GenerateHelpContextMappingFile</a></dt>
           <dd>Whether a simple file, "HelpContexts.txt", containing the
               mapping from help contexts to the destinations should be
               created. The format is the same as with the option
               "GenerateHelpContextIniFile", just that the initial section line
               is missing.</dd>
       </dl>


    <h3><a name="OptionTICCommentDoc"><code>TICCommentDoc</code></a></h3>
       <dl>
         <dt><a name="TICCommentDoc.KeepLineBreaksInComments">KeepLineBreaksInComments</a></dt>
           <dd>Inserts a line break at each line break in the source code at
               the comment.</dd>
         <dt><a name="TICCommentDoc.DocumentationSectionsFilter">DocumentationSectionsFilter</a></dt>
           <dd>Filter some sections of the documentation (mostly lists).</dd>
         <dt><a name="TICCommentDoc.GUIHelpUseTopicAsKeyWords">GUIHelpUseTopicAsKeyWords</a></dt>
           <dd>Whether the headings of the help topics instead of the internal
               component names should be used as key words for the generated
               documentation as help on a GUI.</dd>
       </dl>