I need to document some methods and properties in my Delphi source code. Is there a quick way to get started on this, like some sort of import tool to create the help file structure that I can fill in?
Thank you,
Ed Dressel
Documenting Delphi properties & methods
Moderators: Alexander Halser, Tim Green
Re: Documenting Delphi properties & methods
I suggest you take a look at Documentation Insight from http://www.devjetsoftware.com. I have used it to create internal documentation for many of our functions that are used in multiple projects. It has a framework to help create the documentation covering purpose, parameters, returns, exceptions, comments etc. It integrates with the IDE to pop-up the documentation when you need to use the function. When you are done, it can also generate a Help&Manual project containing all the documentation. I just wish I had time to expand the coverage through more of our code!
- Ed Dressel
- Posts: 226
- Joined: Tue May 11, 2004 6:40 pm
Re: Documenting Delphi properties & methods
Thank you. I found that after posting. It is a bit expensive, but it sounds like it does quite a bit more than I originally needed.
Ed Dressel
Ed Dressel