---
# System prepended metadata

title: Doxygen for OAI

---

# Doxygen for OAI

:::warning
Currently the Doxygen configuration only tested for openair2 folder

got problem on openair1, several file size too big (300kb+)
:::

# Tutorial
1. Copy the Doxyfile to the openaor2 folder
![](https://i.imgur.com/UVBkWW9.png)

2. open terminal
3. cd to the folder
4. type doxygen Doxyfile
    ![](https://i.imgur.com/6SDXpbr.png)
    until you look
    ![](https://i.imgur.com/oytwHj5.png)
5. You will find two new folders: html and latex
    ![](https://i.imgur.com/jJq62i2.png)
6. The result will be on the html\index.html
7. example:
    ![](https://i.imgur.com/USBKPZd.png)

## Adding Description to the document

use /brief for the information about hte struct/ function/ etc
![](https://i.imgur.com/Wq8zXFI.png)
result:
![](https://i.imgur.com/fXXEvId.png)

This one os a good example for function
![](https://i.imgur.com/aPJX7Ft.png)

## Doxyfile
https://pastebin.com/SsC33BjJ