These days a number of commercial and open source tools have been developed for this purpose. However(unfortunately), non of them meet my requirement for specific problem I am dealing with. Currently, I am working on a project that exposes a different classes and functions to user as scripting interface. the user can use the objects from custom scripting interface and call methods to solve some specific problem. The problem I am facing is users of my classes need some sort of documentation in order to write their script efficiently. To address this problem am planing to use the compiler generated XML file to provide context sensitive help, which allows users to mouse over on any of the controls and corresponding methods from the GUI and read the reference documentation of the class/method. Now ... here are my questions: Can I get the sample source code? Can any one give me someone point me to some sort of best approach to address the problem?
A:
Free Pascal has something similar. It has a separate parser that generates XML abstracts separately, which are the basis for the documentation tool (fpdoc)
The Lazarus IDE can read these XML files in the background, allowing to edit the documentation while editing. It of course can also display already entered information. (though more in a wiki-like makeup, not rendered)
Marco van de Voort
2010-05-12 21:40:28