The K Desktop Environment

The KDOC Handbook

Write developer documentation, easily and quickly

Version 2.0.0
Last updated: 10/11/1999

Sirtaj Singh Kang

KDOC generates documentation in a variety of formats, directly from C, C++ and IDL interface definitions. KDOC uses specially formatted comments in the source to allow customized documentation.


Table of Contents
1. Introduction
1.1. What is KDOC?
1.2. Features
1.3. History
2. Using KDOC
2.1. Support and Downloads
2.2. Installation
2.2.1. Supported Environments
2.2.2. Building the distribution
2.3. KDOC at the command line
3. Writing Documentation
3.1. Commenting Source
3.2. Tips on Style
4. Frequently Asked Questions
5. Appendix A: Doc tag reference
5.1. Doc Comments
5.2. Common tags