
KDOC -- C++ and IDL Source Documentation System
Version 2.0

KDOC creates cross-referenced documentation for C++ and CORBA IDL libraries
directly from the source. Documentation can be embedded in special doc
comments in the source.

Also included:

qt2kdoc:	Generates cross-reference index to link kdoc output with 
		Qt documentation.

makekdedoc:	Generates documentation for the KDE libraries.

KDOC 2.0 is still under development.

REQUIREMENTS

You need perl 5.005 or greater to run kdoc.

HOWTO

./configure; make; make install
rehash; man kdoc

should do it. :-)

If you are running this straight from CVS, you will need to run 

	make -f Makefile.cvs

before building.


There is some documentation in doc/

CREDITS
-------

Thanks to the following people for providing testing, feedback, encouragment,
new features and patches:

Bernd Gehrmann
David Sweet
Harald Hoyer
Jochen Wilhelmy
Marcin Kasperski
Rainer Dorsch
Stephane Matamontero
Torben Weis
Wolfgang Bangerth

------
Copyright(C) 1999, Sirtaj Singh Kang <taj@kde.org>
Distributed under the GPL.
