English:

The Free and Open Productivity Suite
Help us Help the World

How to Write C++ Source Code Documentation for Autodoc

Last updated: January 14 2005
Contact: Nikolai Pretzell
Content

Basic Rules
What can be documented
Layout
Tags
Common Tags
Tags for Classes
Tags for Functions
Tags for Variables
Global Tags
A Typical Documentation

Scope

This is a description of how to write documentation within C++ code such it can be automatically parsed by the source code documentation tool Autodoc.

Basic Rules

Logo ApacheCon Europe 2014

Apache Feather

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.