Need2Doc

It is now time to document your source code! You need to document your code, but you don't like days spending on this. The utility program need2Doc will create documentation from your C++ source code, and converts this to a help file for easy accessibility.

Save lots of time with this C++ source code documentor!

 
Need2Doc converts C++ source code into a clear readable help file.

Multiple C++ source files and header files can be inserted into a need2doc project. These file will be filtered on all relevant information. Classes, type definitions, functions and variables are searched and collected into a RTF document. The document will contain an each class function type etc. Additional information with pictures will be inserted into the document. Comments that are available in the source file are searched and put into the document at the right function or definition. A choice to include only public or public and protected or public protected and private members can be made.

After a information is gathered, the documentation will be created, a help project is created, the help is compiled and the result is help with multiple indexes, which looks like a Borland C++ builder help. In fact the generated help is designed to work together with the Borland C++ Builder help in case help is generated for a component. But it's also usable with Microsoft Visual C++ because the help can run on it's own, as a default windows help file.

The generated document can be modified with Microsoft Word or Word Perfect, to include a more specific description of the code, and after it can be conformed to a help file again.

Key Benefits

• Safe days of writing boring documentation.
• Multiple C++ source files and header files can be included
• Fully indexed help file, with summaries of variables and functions split into classes and modules.
• Easy to add your own text
• Compatible with Borland C++ builder language extensions
• Can be just just as printable documentation, and as help file as well.

Future development

We are also working on need2doc for Pascal and Delphi. Please inquire to us if this has any importance for you, this could speed up the developing process...

Also the output is currently Windows Help format, RTF and Word 2000 (or more) documents. HTML will be available in the future.