轉載自http://www.keil.com/support/docs/2734.htm
µVISION: USE DOXYGEN FOR AUTOMATED CODE DOCUMENTATION
Information in this article applies to:
- µVision Version 2.3x
- µVision Version 3.00
QUESTION
I use DoxyGen which is a documentation system for C/C++ to document my source. Is there a way to use it with µVision projects?
ANSWER
Yes. DoxyGen can be integrated with a few simple steps:
Installation
- Get the Windows Installation of DoxyGen from http://www.doxygen.org and run it.
- Optionally you may install AT&T GraphViz, if you want DoxyGen to be able generate graphics. (See link below)
- Open Tools - Customize Tools Menu... in µVision.
- Add a new entry and call it "DoxyGen: Make Template". Settings are:
- Command: C:\Program Files\doxyGen\bin\DoxyGen.exe
- Initial Folder: not required
- Arguments: -g @P.doxy
- Add a new entry and call it "DoxyGen: Generate Documentation". Settings are:
- Command: C:\Program Files\doxyGen\bin\DoxyGen.exe
- Initial Folder: not required
- Arguments: @P.doxy
Usage
- Open the project that you want to document in µVision.
- Use Tools - DoxyGen: Make Template to generate a configuration template for DoxyGen. The file will be placed in the folder where your uv2-file is stored. It will have the project name and the extension .doxy.
- Add the projectname.doxy file to your Source-Tree and open it in the µVision editor. The following settings should be changed:
OPTIMIZE_OUTPUT_FOR_C = YES
WARN_FORMAT = "$file($line): $text"
You should look through the other settings and adjust them. All of them are commented in the .doxy file. - Use Tools - DoxyGen: Make Documentation to start DoxyGen for source files in the project folder.
MORE INFORMATION
FORUM THREADS
The following Discussion Forum threads may provide information related to this topic.
Last Reviewed: Thursday, May 6, 2004