embedded-docs

Solid

Embedded firmware documentation generation and maintenance using Doxygen and related tools. Expert skill for API documentation, hardware interface documentation, memory maps, and integration with documentation systems.

AI & Automation 814 stars 53 forks Updated today MIT

Install

View on GitHub

Quality Score: 95/100

Stars 20%
97
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Embedded Documentation Skill Expert skill for embedded firmware documentation generation and maintenance. Provides Doxygen comment generation, API documentation structure, hardware interface documentation, and integration with documentation systems. ## Overview The Embedded Documentation skill enables comprehensive documentation for embedded firmware projects: - Doxygen comment generation and maintenance - API documentation structure and organization - Hardware interface documentation - Memory map documentation - Call graph and dependency visualization - Version changelog management - Register documentation formatting - Integration with Sphinx/MkDocs ## Capabilities ### 1. Doxygen Comment Generation Generate Doxygen-compatible documentation comments: ```c /** * @file uart_driver.h * @brief UART peripheral driver for STM32F4 series * @author Firmware Team * @version 1.2.0 * @date 2026-01-24 * * @details * This driver provides a hardware abstraction layer for UART peripherals. * It supports: * - Polling, interrupt, and DMA transfer modes * - Hardware flow control (RTS/CTS) * - Configurable baud rates up to 10.5 Mbps * - Error detection and handling * * @note Thread-safe when used with RTOS mutual exclusion * * @par Example Usage: * @code * uart_config_t config = { * .baudrate = 115200, * .parity = UART_PARITY_NONE, * .stop_bits = UART_STOP_1 * }; * uart_init(UART1, &config); * uart_transmit(UART1, data, len, 100); * @endcode * * ...

Details

Author
a5c-ai
Repository
a5c-ai/babysitter
Created
4 months ago
Last Updated
today
Language
JavaScript
License
MIT

Related Skills