DoxyGen

DoxyGen is a tool to create a documentation from annotated source files.

Download the newest DoxyGen from http://www.doxygen.org and install it :D

If you want to install DoxyGen automatically you have to create a batch-file.
Download DoxyGen and proceed with the steps below.

To create a response-file, start the installation with the following parameter:

doxygen-1.8.10-setup.exe /SAVEINF=doxygen.inf

This will create a .inf file with, more or less, the following content:

[Setup]
Lang=default
Dir=C:\Program Files\doxygen
Group=doxygen
NoIcons=1
SetupType=full
Components=main,gui,docs_html,docs_chm,examples
Tasks=

Create a batch-file, e.g. silent_install.cmd, with the following content:

@echo off
doxygen-1.8.10-setup.exe /SILENT /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /LOADINF=doxygen.inf

For deinstalling DoxyGen silently create a second batch-file with the following content:

@echo off
%ProgramFiles%\doxygen\system\uninst000.exe /SILENT /VERYSILENT /SUPRESSMSGBOXES /NORESTART

1. Open Tools - Customize Tools Menu… in µVision.
   
2. 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
     
3. 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
     

TODO: Check if complete

1. Open the project that you want to document in µVision.
2. Use Tools - DoxyGen: Make Template to generate a configuration template for DoxyGen. The file will be placed in the folder where your .uvprojx-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 µVision editor. The following settings should be changed:
   OPTIMIZE_OUTPUT_FOR_C = YES
   WARN_FORMAT = “$file($line): $text”
   GENERATE_LATEX = NO
   PROJECT_NAME, INPUT
   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.