changelog.html

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

            parsed. Also added an option to generate only this user
            documentation.</li>
        <li>Three methods of <code>TIdentifierParser</code> have been removed,
            they had been marked as <b>deprecated</b>. To a degree they have
            been replaced by <code>IsEndOfStmtToken</code>.</li>
      </ul>


    <h3>changes (Version 1.3.0.176):</h3>
      <ul>
        <li>Internal optimizing: faster parsing;
            everything else is remarkably faster.</li>

        <li>Added list of all overriding methods of a method. Better format of
            text in block mode in the PDF generator. Saving/Loading of parsed
            data updated for changes of last version. Old files can still be
            loaded. Fixed error in size of generated WMF files.</li>
        <li>Clean up: removal of some useless inline commands and
            variables. Added some new variable texts.</li>

        <li>It compiles and generates on <b>Kylix</b>!</li>

        <li><b>The program has (finally) been GPL'ed!</b></li>

        <li>Command line version gots finally a <i>progress bar</i>. It does
            work in Delphi and Kylix and will be shown by default.<br>
            This also introduces some smaller changes of the program parameter
            options. <code>-q</code> has been deleted, verbose mode will now be
            disabled by a capital <code>-V</code> (enabled by a lower case
            <code>-v</code>). The progress bar is disabled by a capital
            <code>-R</code> and re-enabled by <code>-r</code>.<br>
            Ctrl-C will abort the current progress, like the abort button in the
            GUI. Any other signal (besides SIGQUIT) under *nix and Ctrl-Break
            in Windows will kill it instantly.</li>

        <li>Several distributed
            improvements/corrections/extensions/changes.</li>
      </ul>

    <h3>changes (Version 1.2.4.158):</h3>
      <ul>
        <li>An ini file for the application and the generators is used.</li>
        <li>Fixed HMTL-generator.</li>
        <li>Changes at the PDF-generator (fixed links to members).</li>
        <li>A scroll bar for the component showing the parsed source code and
            an option to use names of parameters as sections for their comments
            have also been added. Indices of array properties are parsed now.
            The variant parts of records are also now saved, but this doesn't
            appear in the documentation so far (any suggestions how it
            should?).</li>
        <li>Several distributed
            improvements/corrections/extensions/changes.</li>
      </ul>

    <h3>changes (Version 1.2.4.150):</h3>
      <ul>
        <li>After I shelved it for a long time I actually started at the
            <b>PDF generator</b> and, well, the concept I conceived works
            better than expected and I think it is finished. The created PDF
            files look almost like the PDF files created with the generated
            files of the
            L<small><sup>A</sup></small>T<small><sub>E</sub></small>X
            generator.</li>
        <li>Fixed: Generator for
            L<small><sup>A</sup></small>T<small><sub>E</sub></small>X will now
            show the used global identifiers.</li>
        <li>The names of the sections in the comments can be changed.</li>
        <li>Abstract methods are marked.</li>
        <li>Several distributed
            improvements/corrections/extensions/changes.</li>
      </ul>


    <h3>changes (Version 1.2.3.142):</h3>
      <ul>
        <li>Restructurizing of GUI and help.</li>
        <li>Finally added the capability to parse the
            <code>$INCLUDE</code>-compiler command. </li>
        <li><code>$X</code> now affects if there is a
             <code>Result</code>-variable in functions.</li>
        <li>The order of the parsing of the files depends now on the
            internal/mutual usage of the files (needed for conditional
            compiling).</li>
        <li>A serious bug in the compiler defines dialog was fixed. </li>
        <li>Function types now also parse the ~param and ~result sections like
            functions.</li>
        <li>Several distributed
            improvements/corrections/extensions/changes.</li>
      </ul>


    <h3>changes (Version 1.2.2.125):</h3>
      <ul>
        <li>The in Delphi 6 introduced portability issue-directives
            <b>deprecated</b>, <b>library</b> and <b>platform</b> are
            recognized and parsed, also finally the initialization of variables
            with <b>absolute</b>. But the parsing of the new concept of
            conditional compiling needed some bigger changes and can only
            evaluate simple expressions. <code>True</code> and
            <code>False</code> shouldn't be declared (i.e. not in
            <code>SystemIdents.txt</code>) to use boolean constants.</li>
        <li>Program-parameter for an (minimum) integration in the Delphi-IDE.
            By adding <em>DelphiDoc</em> to the Tools-menue of Delphi and
            entering the parameters
            &quot;<code>$SAVEALL $SAVE -e $EXENAME</code>&quot; (and others)
            it's relatively easy to generate documentation for the current
            project (also see the help of the program-parameters with
            &quot;<code>-?</code>&quot;). A small note: They are also fully
            functional in the GUI-version.</li>
        <li>The <b>initialization</b>- and <b>finalization</b>-sections and
            the main program are treated as special functions and appear as
            such in the documentation.</li>
        <li>Several distributed
            improvements/corrections/extensions/changes.</li>
      </ul>


    <h3>changes (Version 1.2.2.111):</h3>
      <ul>
        <li>Corrected the lists of files and classes and inserted page breaks
            (via macros) in the generator of documentation in the format
            L<small><sup>A</sup></small>T<small><sub>E</sub></small>X. Added
            also the sorting of the files and classes. Corrected the
            ~[preformatted ] and ~[sample ]-inline commands.</li>
        <li>With the Expert-options can be chosen where to get the comment of
            an identifier, from the interface or its implementation. When
            choosing a generator in the GUI all values of common Expert-options
            of the old generator are applied to the new one.</li>
        <li>Something I forgot to mention before: in both, the command-line
            program and the GUI-version are parameter possible, just start with
            <code>-?</code> to see them.</li>
        <li>Something else I forgot: The values of the Expert-options can be
            read out of the project file, if the correct generator was chosen
            prior opening it. The options have to be put manually into the file
            in an Ini-section with the exact name of the generator ([THTMLDoc],
            [TWinHelpDoc] or [TLaTeXDoc]) in the usuals format Name=Value.</li>
      </ul>

    <h3>changes (Version 1.2.2.109):</h3>
      <ul>
        <li>Another generator for
            L<small><sup>A</sup></small>T<small><sub>E</sub></small>X source
            has been added. It is very much beta but seems to work so far. Any
            comments on the documentation would be appreciated.</li>
      </ul>

    <h3>changes (Version 1.2.0.106):</h3>
      <ul>
        <li>Besides Xfig-files also WMF-files (Windows Meta Format) are
            generated, which should be easily insertable into
            Office-documents.</li>
        <li>Templates for the beginnings and the ends of the generated
            HMTL-files can be defined with the Expert-options.</li>
        <li>A very simple preview of the generated Xfig-files is available in
            the GUI.</li>
      </ul>

    <h3>changes (Version 1.2.0.100):</h3>
      <ul>
        <li>Comments can be <i>ignored</i> with the Expert-options.</li>
        <li>Windows help files can automatically be compiled and also launched
            with the Expert-options.</li>
        <li>Automatic generation on one or more projects with command-line
            options.</li>
        <li>Command-line program now available. I decided against a dll/package
            for both executables because Delphi supports this in theory but in
            practice in it's not correctly implemented in version 4.</li>
        <li>Step-by-step choosing of the files to parse and not is now
            possible.</li>
        <li>Both generators create an index of all identifiers and files
            (finally).</li>
        <li>~example is finally parsed.</li>
        <li>Files with additional documentation not attached to identifiers can
            be inserted in the documentation (~[userDoc FilePath]). It is also
            parsed; the syntax of the comments apply to them as well.</li>

        <li>the usual corrections</li>
      </ul>

    <h3>changes (Version 1.1.1.46):</h3>
      <ul>
        <li>It should be possible to change the special comment character
            &quot;~&quot; (to use &quot;@&quot; instead) with the button
            <b>Expert</b>.<br>&nbsp;</li>

        <li>The unintentional whitespaces in the generated Windows help files
            should be disappeared (they were already a day after the last
            update, but I was to lazy to upload the update again).</li>
        <li>Files are now in the INI-format to facilitate future changes.</li>
        <li>Revision of the GUI.</li>
        <li>the usual corrections</li>
      </ul>

    <h3>older changes:</h3>
      <ul>
        <li>Generation of a help project to create Windows help files is now
            possible.</li>
        <li>the usual corrections</li>
      </ul>

    <h3>old changes:</h3>
      <ul>
        <li>Noticeable more cross-references (links);
            (hopefully) better structuring</li>
        <li>index of all methods</li>
        <li>Parsing of all comments (versus the simple copying into the
            documentation) <a href="comments.html">see here</a></li>
        <li>GUI has been optimized somehow</li>
      </ul>








    <h2><a name="TODO">TODO</a></h2>

      <p>None of the following things has so far raised any issue or is not a
         priority to to make. To be honest, this list is rather old and I don't
         use it anymore or even look at it. But if anyone ever has a problem
         or something similar with any item in this list feel free to remind me
         of it.</p>

      Things to add or to correct:
      <ul>
        <li>Recognize identifiers in assembler blocks.</li>
        <li>Distinction of used overloaded procedures is not sufficient, that
            means there is no such thing, always the first is used.</li>
        <li>Calling of methods of [Ole]Varianten should be ignored (treating
            Variant as a type of its own).</li>
        <li>With &quot;<code><b>on</b> E: SomeException <b>do</b></code>&quot;
            access on private/protected fields of E should be possible if
            permitted.</li>
        <li>Parsing of the types of parameters of overloaded procedures, if
            the name of the file (unit) has been given in some cases, should be
            corrected(/tested).</li>
      </ul>

      Already added/corrected features, but still to be tested:
      <ul>
        <li>All paths are correctly and in case of relative paths also relative
            to the correct path recognized and treated?</li>
        <li>Complex URIs in external links in documentation of WinHelp
            (what characters have to be quoted in RTF/WinHelp inside such a
             command?)<br>&nbsp;</li>

        <li>Unit-aliases are correctly recognized and used?</li>
        <li>Default property is correctly recognized after arrays?</li>
        <li>Recursive callings of functions are recognized correctly?</li>
        <li><code><b>raise</b> Exception-expression <i>at</i> Address</code>
            always correctly recognized?</li>
        <li>Methods of classes that implement interfaces should be parsable
            (no sample code available):<br>
            <b>function</b> IUnknown.QueryInterface = MyQueryInterf;<br>
            Also there seems to be changes to Delphi 7, that force to use the
            original name of the interface always.</li>
        <li>&quot;<b>array of const</b>&quot;-parameter correct?</li>
        <li>Recognition of unknown units as identifiers is correct?</li>
      </ul>


  </body>
</html>