Documentation Generation Guide

This guide explains how to generate HTML documentation for the SDK header files using the provided automation script.

Prerequisites

• Doxygen 1.13.2: Ensure Doxygen is installed and added to your system PATH. You can download it from the official website.
• Windows OS: The automation script is a Windows Batch file.

How to Generate Documentation

We have provided a batch script to automate the entire process. It will configure the environment, run Doxygen on all .h files in this directory, and open the results.

1. Open a terminal or command prompt in this folder: powershell cd c:\Users\<User>\<path to the folder>
2. Run the generation script: powershell .\generate_doxy_html_docs.bat

What the script does:

• Copies necessary Doxygen resources/configs.
• Scans all .h files in the current directory.
• Generates HTML documentation in a new html/ folder.
• Automatically opens html/index.html in your default web browser.

How to Modify Documentation

The documentation is generated directly from the source code comments.

1. Edit Header Files: Open any .h file (e.g., gpio.h, i2c.h) and modify the Doxygen-style comments (blocks starting with /** or commands like \brief, \details).
2. Edit Snippets: Code examples referenced in the documentation are stored in the snippets/ folder. You can edit these .c files to update the examples shown in the docs.
3. Regenerate: After making changes, run generate_doxy_html_docs.bat again to see your updates.

Folder Structure

• *.h: Header files containing the API definitions and documentation comments.
• snippets/: Contains code examples referenced by \snippet commands in the header files.
• generate_doxy_html_docs.bat: The script to build the documentation.