Developer Documentation Writing Howto
   Next

Developer Documentation Writing Howto

Niels Reedijk

2005-10-26

Revision History
Revision 12005-12-23nielx
First section about documenting classes on review.

Abstract

This guide is for Haiku Developers that need to write developer documentation.

Table of Contents

1. Introduction
2. Documenting Classes
Documenting a new class
Where do I place my file?
How do I name my file?
What should be the initial contents of the file?
How do I hook in the file into the generated documentation?
Formal formatting of a class
What elements should be in class documentation?
How do I write a proper methodsynopsis?
A. MIT License
   Next
   Chapter 1. Introduction