changelog.html

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

            like the un-strict scopes), multicast eventhandlers/properties,
            <code><b>for ... in ... do</b></code>. Only partial support for
            file-namespaces. Still no support for nested types and class
            constants. UTF-8 still possible (now legal in identfiers), Unicode
            not supported.</li>
        <li>Fixed cross-references in the documentation. Due to a problem with
            filtering the sections, they were almost always filtered.</li>
        <li>Fixed loading of options of generators by the hierarchy.</li>
        <li>A simple algorithm to automatically layout diagrams of files is now
            also available.</li>
        <li>Generator HMTL-Help: Fixed read-only and abstract icons, when
            compiling with own sub-sub-directories for record-like types.</li>
        <li>Fixed some D7-incompatibilities in the source code (hopefully not
            created new ones). The warning messages about unsure types and code
            constructs in the source code are disabled by default.</li>
        <li>Changed the command line parameters slightly. F.i. added the
            <code>-k</code> to keep the parsed data to generate documentation
            about it several times or to load previously parsed data from a
            file.</li>
        <li>Fixed parsing of the .cfg/.conf file of programs when more than one
            package is used.</li>
      </ul>



    <h3>changes (Version 1.5.0.255):</h3>

      <ul>
        <li>Added a simple wizard/tour.</li>
        <li>Added ~[diagram ] to create diagrams and  insert them into the
            documentation.</li>
        <li>Checked compiling with Kylix again. Fixed form to create diagrams
            (mostly). Fixed tree view of the options of the generator. Added
            the "ConvertForKylix.tcl" to make an easier transition.</li>
        <li>Added "Reset" button to parse a new project.</li>
        <li>Fixed option IdentifierSectionsFilter of generator
            TFormatCommentDoc.</li>
        <li>Fixed parsing of "class of SomeType" if SomeType is only a type
            reference to a class instead of the class itself.</li>
        <li>Fixed using of 16-bit bitmaps with the WinHelp Generator if their
            width is an odd number (32-bit alignment).</li>
        <li>Fixed alignment of images in PDF, now centered (as supposed)
            instead of right-aligned.</li>
        <li>Generating a warning message if a file of ~[includeFile FileName]
            isn't found.</li>
        <li>String options of the generators are no longer limited to 255
            characters.</li>
      </ul>





    <h3>changes (Version 1.4.1.249):</h3>

      <ul>
        <li>Extraction of content of comments with Regular Expressions.</li>
        <li>Expanded the option "UseSubdirectories" of the HTML Help generator
            to allow spread the generated source HTML files in more
            sub-directories and sub-sub-directories.</li>
        <li>Manual headers of HTML files are now defined with only one file,
            replacing some special tags with the actual content.</li>
      </ul>


    <h3>changes (Version 1.4.0.246):</h3>

      <ul>
        <li>Localization of key words is now possible.</li>
        <li>A progress window will be be shown, even when only generating the
            user documentation or documentation about a GUI.</li>
        <li>Releasing the sources for the help on the GUI of
            <em>Delphidoc</em>.</li>
        <li>Command line version got an additional switch "-auto" to skip the
            waiting on a key at the end.</li>
        <li>Images can be included. Renamed two options of the PDF generator
            regarding images.</li>
        <li>Added options "FileName" to several generators.</li>
        <li>Several options to filter some parts of the documentation added,
            take a look in the category "Generation.Filter".</li>
        <li>The PDF generator got an option "TableOfContentsDetailLevel" to
            limit the topics to list in the table of contents.</li>
        <li>The HTML Help generator got the option "UseSubdirectories" to
            spread the generated source HTML files in several
            sub-directories.</li>
        <li>Fixed images in the PDF generator. Fixed links from the user
            documentation to identifiers or files. Fixed the inline command
            ~[userDoc ] while generating help on a GUI. Fixed compression of
            Windows Help files (option was reversed).</li>
      </ul>






    <h3>changes (Version 1.4.0.239):</h3>

      <ul>
        <li>Added a <a href="manual.html#FormatHTMLHelp">generator to generate
            Compiled HTML Help files</a> (<code>.chm</code>). Lots of files are
            generated, even more than with the HTML generator, which are then
            compiled to a big help files using Mircosoft's HTML Help Workshop.
            Help contexts work like in the WinHelp generator.</li>

        <li>The new HTML help format is now also used as the help for the GUI
            of <em>DelphiDoc</em> (to reduce the size). The connection from the
            program to the help file is done with a few units supplied by
            courtesy of <a href="http://www.helpware.net/delphi/">The Helpware
            Group</a>.</li>

        <li>The WinHelp format got a content file. The normal HTML files got
            some key words.</li>
      </ul>



    <h3>changes (Version 1.3.4.232):</h3>

      <ul>
        <li>Added inline command <code>~[HelpContext <i>HCNumber</i>]</code> to
            specify a help context for a topic in the documentation. Added
            extraction of the help context of the window itself.</li>

        <li>Added PNG support for Kylix.</li>

        <li>Parsing of <code>^J</code> to insert special characters (here
            <code>#10</code>) should now also work directly at other string
            constants.</li>

        <li>Compression in Segmented Hyper Graphic (SHG) image files to be used
            in the windows Help files with links is now possible, but it seems
            they are not compressed inside the generated file, so this feature
            is disabled by default in this release of <em>DelphiDoc</em>.</li>
      </ul>




    <h3>changes (Version 1.3.4.231):</h3>

      <ul>
        <li>Documentation as a help on a GUI can be generated in the formats
            HTML, PDF and Window Help files, all using a screen shot of the
            window with clickable components to get to the help.<br>
            The Windows Help file also uses the <code>HelpContext</code>
            property of the components and links the help topics to them. A
            help file for <em>DelphiDoc</em> is now also included.</li>

        <li>Two sets of parsed datas can now be simply compared.</li>
        <li>Saving of all <code>$INCLUDEd</code> files.</li>

        <li>Fixed the <i>generator</i> to extract the source code to use the
            correct names of the directories in the path. Fixed inline command
            <code>~[defineTextIf ]</code>.</li>
      </ul>



    <h3>changes (Version 1.3.3.219):</h3>

      <ul>
        <li><b>Diagrams</b> of the parsed data can now be created, class
            diagrams and diagrams of the files. The design and one of the
            algorithms to automatically layout the diagrams have been
            copied/tranfered from
            <a href="http://sourceforge.net/projects/essmodel/"
            >ESS Model</a>.</li>

        <li>Fixed the PDF generator again not to write several lines over each
            other at the top of the pages.</li>
        <li>Fixed setting of numeric options of the generators by name. Always
            use the point &quot;.&quot; as the decimal separator in floating
            point numbers (this is more portable).</li>

        <li>Managing of several parsed datas. This has currently no purpose,
            but the functionality to compare two sets of parsed data should be
            added in one of the next releases.</li>
      </ul>





    <h3>changes (Version 1.3.2.210):</h3>

      <ul>
        <li>Created a generator to export all classes and interfaces to a
            UML XMI file.</li>
        <li>Again fixed the sorting of lists of identifiers. One
            identifier was dropped sometimes.</li>
        <li>Finally implemented option <code>OnlyPublicIdentifiers</code> and
            added also <code>IgnoredPortabilityIssues</code> to filter the
            identifiers and files to generate documentation about.</li>
        <li>Fixed internal cloning of properties (shouldn't matter). Fixed
            redirection of methods of implemented interfaces to methods with
            another name. Fixed order of the attributes/directives of
            functions. Fixed links and description of enumeration types and
            items.</li>
      </ul>


    <h3>changes (Version 1.3.1.195):</h3>

      <ul>
        <li>Corrected the kind of the members in each list. Fields and
            properties were interchanged, what a mess!</li>
        <li>After the last rework of properties now also changed the
            saving/loading to/from a file.</li>
        <li>Parsing of obsolete and ignored parameter list of a program
            possible.</li>
        <li>More precise parsing of the <b>exports</b>-clauses. Also generating
            lists of all exported identifiers.</li>
      </ul>



    <h3>changes (Version 1.3.1.190):</h3>
      <ul>
        <li>Interpreting of <code>{$I file}</code> as
            <code>{$INCLUDE file}</code>. Better positions of errors in
            included files.</li>
        <li>Correction of sorting of lists of identifiers (not members).</li>
        <li>Correction of some links in the HTML-generator. Corrected position
            of line break in lists (conform to standard). Added CSS-class'es to
            several tags to allow better customizing via CSS.</li>
        <li>Corrected option RemoveLeadingStars to handle empty lines in
            comments. Added two options pertaining comments:
            KeepLineBreaksInComments and UseOnlyStaredComments. Added two new
            sections: ~author and ~version and three additional sections to be
            defined by the user.</li>
        <li>Rework of the parsing of properties and saving of all parsed
            directives.</li>
      </ul>


    <h3>changes (Version 1.3.1.184):</h3>
      <ul>
        <li>Support of <b>Localization</b>. Added two compiler switches:<br>
            <code>-l Name=Text</code> (lower L) assigns a text to a named
            value.<br>
            <code>-L LanguageOrFile</code> (capital L) loads the file of
            localized texts or if it does not exist tries to use it as a
            language to be used. Only &quot;english&quot; and
            &quot;deutsch&quot; (and &quot;german&quot;) are supported
            internally so far.</li>
        <li>Corrected two errors when <code>{$INCLUDE }</code>ing some
            files. Also checked, that always the correct ini file (in the same
            directory as the executable) is used.</li>
        <li>Using left alignment for lists of identifiers in PDF
            documentation. Creating links to local files with
            <code>~[linkExtern ]</code> if no protocol
            (<code>&quot;://&quot;</code>) is specified.</li>
        <li>Added the possibility to define additional constants for
            conditional compiling, like <code>RTLVersion</code>,
            <code>CompilerVersion</code> and <code>GPL</code> in unit System.
            Also changed the records <code>TDefines</code> and
            <code>TDefineOptions</code> to classes and the version of saved
            parsed data to &quot;1&quot; and also of the parser class.</li>
        <li>Faster saving of parsed data by using binary trees to access the
            indices of the identifiers and files.</li>
        <li>A list of all still not implemented abstract methods is generated
            in the documentation of all abstract classes.</li>
        <li>Added checks, whether names of identifiers are valid. Also added
            lists for each unit, which files use them, including packages and
            even programs using/requiring packages.</li>
        <li>Added an extra list for library files and directories. These files
            are only parsed if they are used by other files.</li>
        <li>Added a list box to add additional files of user documentation like
            <code>~[userDoc ]</code>. Usefull if the comments shouldn't be