The K Desktop Environment

The KDOC Handbook

Write developer documentation, easily and quickly

Version 2.0.0
Last updated: 17/11/2000

Sirtaj Singh Kang

Copyright © 1999, 2000 by Sirtaj Singh Kang

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

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. Credits and Licenses
A. Doc tag reference
A.1. Doc Comments
A.2. Common tags
A.3. Tags for Library Documentation
A.4. Tags for Classes
A.5. Tags for Functions
B. Utilities
B.1. qt2kdoc: Link with Qt™ HTML documentation
B.2. makekdedoc: Generate docs for KDELIBS and other groups of libraries
C. Other useful tools
  Next
  Introduction