CT Board

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== DoxyGen ====== 

===== Installation =====

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

==== Manual Installation ====

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

==== Silent Installation ====

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

=== Create a Response-File ===

To create a response-file, start the installation with the following parameter:
<code>
doxygen-1.8.10-setup.exe /SAVEINF=doxygen.inf
</code>

This will create a //.inf// file with, more or less, the following content:
<code>
[Setup]
Lang=default
Dir=C:\Program Files\doxygen
Group=doxygen
NoIcons=1
SetupType=full
Components=main,gui,docs_html,docs_chm,examples
Tasks=
</code>

=== Silent Installation ===

Create a batch-file, e.g. //silent_install.cmd//, with the following content:
<code>
@echo off
doxygen-1.8.10-setup.exe /SILENT /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /LOADINF=doxygen.inf
</code>

For deinstalling DoxyGen silently create a second batch-file with the following content:
<code>
@echo off
%ProgramFiles%\doxygen\system\uninst000.exe /SILENT /VERYSILENT /SUPRESSMSGBOXES /NORESTART
</code>

===== Integration in Keil =====

  - 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 in Keil =====

<code>
TODO: Check if complete
</code>

  - 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 .uvprojx-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" \\ **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.
  - Use //Tools - DoxyGen: Make Documentation// to start DoxyGen for source files in the project folder.