ARM Technical Support Knowledge Articles

USE DOXYGEN FOR AUTOMATED CODE DOCUMENTATION

Applies to: uVision IDE

Answer


Information in this article applies to:


QUESTION

I use DoxyGen which is a documentation system for C/C++ to document my source. Is there a way to use it with uVision projects?

ANSWER

Yes. DoxyGen can be integrated with a few simple steps:

Installation

  1. Get the Windows Installation of DoxyGen from http://www.doxygen.org and run it.
  2. Optionally you may install AT&T GraphViz, if you want DoxyGen to be able generate graphics. (See link below)
  3. Open Tools - Customize Tools Menu... in uVision.
  4. Add a new entry and call it "DoxyGen: Make Template". Settings are:
    • Command: C:Program FilesdoxyGeninDoxyGen.exe
    • Initial Folder: not required
    • Arguments: -g @P.doxy
  5. Add a new entry and call it "DoxyGen: Generate Documentation". Settings are:
    • Command: C:Program FilesdoxyGeninDoxyGen.exe
    • Initial Folder: not required
    • Arguments: @P.doxy

Usage

  1. Open the project that you want to document in uVision.
  2. 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.
  3. Add the projectname.doxy file to your Source-Tree and open it in the uVision 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.
  4. Use Tools - DoxyGen: Make Documentation to start DoxyGen for source files in the project folder.

MORE INFORMATION

Article last edited on: 2004-05-06 12:58:41

Rate this article

[Bad]
|
|
[Good]
Disagree? Move your mouse over the bar and click

Did you find this article helpful? Yes No

How can we improve this article?

Link to this article
Copyright © 2011 ARM Limited. All rights reserved. External (Open), Non-Confidential