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
- Windows 95/NT and Solaris 2.4 binaries.
- Parse sources for Visual C++ (2.x, 4.x), Borland C++ (4.x, 5.x), IBM CSet++ and Sun C++ 4.x compilers.
- The generated documentation is 100% compatible with Internet browsers.
- Parse up to 10.000 lines per minute (486 DX66 16Mo).
- Groupware support, Multi site search engine.
- Native language support (English and French included).
Futur features
- Metrics on classes Add-on (soon)
- Incremental generation (soon)
- Visual Basic 4.x and Power Builder 5.x Modules
- MkHelp DataBase API
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.
- version 1.0.2
- Add socket communication for GUI (server mode)
- Fix many C++ grammars parse errors
- Fix internal preprocessor errors
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.