What’s New in Documentation Insight V2

Documentation Insight V2 includes several highlights and many improvements:

1. Documentation Generator

The Enterprise version provides a tool set to help you produce  rich documentation files (e.g. Html, CHM, MSHelp2, Help & Manual) with only a few steps.  For more details, see this tutorial:

How to Generate Documentation from Delphi Source Code

2. Live Documentation Explorer

The Documentation Explorer will construct the code structure of the projects in a second. It makes it easier to understand the code library and document your code. We plan to add syntax definition, object graph, edit member summary, auto sync, and more features in future releases.

3. Live Spell Check

With the integration of Addict4, it is possible to perform live spell check while writing documentation. (Only available in the Design mode)

4. Documentation Formatter

This tool helps you format all well-formatted xml documentation to the new style for better readability (Good for V1.x users). It also solves some other issues (e.g.  line breaks for <see> tag causes compiler xmldoc generation failed)  .

 

5. Validate XML Documentation

This feature will check all xml documentation and show invalid pieces in the Messages window. It makes it easier to correct all xmldoc comments errors.

6. Easier to add a code reference

A live code structure tree will be shown in the Hyperlink window.

7. Other Improvements

* Improved XMLDoc formatting for better readability

* Support Unicode Documentation

* Support More Code Elements (Project/Package/Library/ResourceStrings/NestedRoutines)

* Support Events

* Support Parameters/Return Type for Procedural Types

* Integration with latest Enhanced Help Insight template

* Many bug fixes

15 comments

    1. Hi, Bernhard, Thanks for your upgrade to V2! We have been requested by many customers to do a professional documentation generator which can create html/chm/pdf/vshelp/help & manual templates, etc. And we are actively working on it.

  2. thanks for the answer, waiting for the next updates 🙂

    another future feature request

    DESIGN BY CONTRACT features may be stored in the XML documentation block, something simillar to JAVA features

    1. Could you take some to explain what “DESIGN BY CONTRACT” is and how to apply it in DI?

      It should be also mentioned, due to the huge work, the documentation generator will be a standalone product.

  3. the basic idea of design by contract means you add TAGS in the source code documentation (java doc) .
    Using this tags you may generate a contract program which will check your code if the code is matching the requirements. eg. for a function sqrt(x) you may add in the XML Doc tags that x should never become negative.

    Did not see any corresponding ideas in the XML source code documentation systems as used now for java and
    java doc.

    Only EIFFEL is a pure design by contract language, as Java and Delphi only have more or the the assert statement there will be no full Design by Contract solution in the near future. But may be a starting point is better than nothing.

  4. IMHO, design by contract should be supported by compiler) otherwise, contracts can be easely destroyed by incorrect code.

    And i did not quite sure about differences between “contract” and requirement for delphi code. If you have some requirements for your function, you should check them inside function. If you have contract? Who checks if X in your sample is positive?

  5. I’m using the latest version of DI professional registered.
    Why does the Hyperlink function only display Public methods? I’m trying to create a link to a private method I’ve written. for example

    ///
    /// Uses {I wrote this tag by hand.}
    ///

    Also is there any way of inserting XML tags into the design other than those automatically generated?

    1. I’m sorry but your web reader stripped out the XML example I’m going to place them into quotes and see if they get through

      “/// ”
      “/// Uses ”
      “/// “

  6. No did not get through I’m going to replace the angle brackets with square brackets

    /// [remarks]
    /// Uses [see cref=”TframeEnter.cm_isPaymentComplete” /]
    /// [/remarks]

  7. Could you bring back the ‘Refresh from source’ button – it is available in the free version, but is missing in the latest professional version.

    I use MMX and found it useful to be able to write XML directly into my source from MMX and the to refresh DI to use the new source.

Leave a comment