1 Introduction


Welcome to the MkHelp for C++ user's guide. It presents how to use MkHelp.

MkHelp is a documentation automatic generator. From yours C/C++ files, it builds a HTML set of documentation for classes, functions, variables and files.


1.1 Features

Futur features


1.2 How to start

At first, see install for a complete installation.

To use internal MkHelp preprocessor you have to specify the #include files path and internals #define of your compiler. Modify the two following lines generator.preprocessor.include and generator.preprocessor.define in mkhelp.ini.

You can use MkHelp with your own preprocessor, just make a 'i' file and set the -P option. For example :
mkhelp -P ex1.i
where ex1.i is a ex1.cpp preprocessed file with your cpp preprocessor.


1.3 Examples

Go in ./mkhelp/example.
Run demo.bat (Borland Compiler setup by default) or demo.csh to generate the documentation.
Start your browser with index.html.


1.4 What's New

The last version is 1.0.2 (96/12/09), with a major adding : socket communication with a graphical client. MkHelp could now support multiple WIN95/NT GUI clients.

The complete history of MkHelp


Netscape is a trademark of Netscape Communications Corporation, All rights reserved
Borland is a trademark of Borland International Inc.
IBM is a trademark of International Business Machine.
Sun is a trademark of Sun Microsystem.