doxygen:doxygen
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| doxygen:doxygen [2009/02/10 16:26] – created nchiap | doxygen:doxygen [2009/07/25 14:22] (current) – decianm | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== | + | ====== |
| - | ==== Creating a documentation ==== | + | ===== Introduction ===== |
| + | Doxygen is a system for a nice documentation of code in projects. | ||
| + | |||
| + | ===== Creating a documentation | ||
| Creating the doxygen documentation for all files in a directory is simple. All you need is a configuration file which doxygen can generate for you. So starting from scratch you do: | Creating the doxygen documentation for all files in a directory is simple. All you need is a configuration file which doxygen can generate for you. So starting from scratch you do: | ||
| Line 15: | Line 18: | ||
| $ doxygen | $ doxygen | ||
| </ | </ | ||
| + | |||
| + | ===== Rules for documentation ===== | ||
| + | To find out how to document the code, have a look at: | ||
| + | [[http:// | ||
| + | |||
| + | GetPacking projects from CVS and looking at the header-files may be a good introduction as well. | ||
| + | |||
doxygen/doxygen.1234279600.txt.gz · Last modified: 2009/02/10 16:26 by nchiap
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
