Documenting Delphi properties & methods

Please post all questions on Help+Manual 8 here

Moderators: Alexander Halser, Tim Green

Post Reply
User avatar
Ed Dressel
Posts: 226
Joined: Tue May 11, 2004 6:40 pm

Documenting Delphi properties & methods

Unread post by Ed Dressel »

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
Tim Frost
Posts: 319
Joined: Mon Nov 22, 2004 11:45 pm

Re: Documenting Delphi properties & methods

Unread post by Tim Frost »

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!
User avatar
Ed Dressel
Posts: 226
Joined: Tue May 11, 2004 6:40 pm

Re: Documenting Delphi properties & methods

Unread post by Ed Dressel »

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
Post Reply