- 论坛徽章:
- 0
|
Three months ago I wanted to study doxygen. Hopefully I can done more than before.
Doxgen is a documentation system for C++, C, Java, Objective-C, python, cobra and to some extent PHP, C# and D. Its' homesite is www.doxygen.org or http:// www.stack.nl/ ~dimitri /doxygen/ . The latest version is 1.5.1
My environment is ubuntu6.10 and doxygen 1.4.7 gotten from my sources list. It includes doxygen, doxytag, doxywizard and doxygen-doc. You can get information from there located at /usr/share/doc/doxygen. The follow is an explanation of simple use of command doxygen.
You can use doxygen in a number of ways:
1) Use doxygen to generate a template configuration file:
doxygen [-s] -g [configName]
If - is used for configName doxygen will write to standard out‐\n put.
2) Use doxygen to update an old configuration file:
doxygen [-s] -u [configName]
3) Use doxygen to generate documentation using an existing configura‐\n tion file:
doxygen [configName]
If - is used for configName doxygen will read from standard
input.
4) Use doxygen to generate a template style sheet file for RTF, HTML or
Latex.
RTF: doxygen -w rtf styleSheetFile
HTML: doxygen -w html headerFile footerFile styleSheetFile [config‐\n File]
LaTeX: doxygen -w latex headerFile styleSheetFile [configFile]
5) Use doxygen to generate an rtf extensions file
RTF: doxygen -e rtf extensionsFile
If -s is specified the comments in the config file will be omitted. If
configName is omitted ‘Doxyfile’ will be used as a default.
The above usage is the threshold of studying doxygen. The more exercises are done, the more experience will be gotten.
本文来自ChinaUnix博客,如果查看原文请点:http://blog.chinaunix.net/u/32126/showart_248893.html |
|