doxygen
OfficialDocument code with Doxygen, consistently.
Software Engineering#documentation#standards#code-quality#cpp#inline-comments#doxygen#header-comments
Authorsmart-swimmingpool
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Inline documentation standard for the pool-controller C++ codebase using Doxygen. It defines how to annotate files, classes, and methods so the codebase remains well-documented and maintainable across modules.
Core Features & Use Cases
- Enforces file-level, class/struct, and public member documentation using Doxygen tags like @file, @brief, @param, and @return.
- Provides guidance for header and source file comments, including private method notes and macro/documentation conventions.
- Enables consistent, automated API documentation generation for embedded C++ projects.
Quick Start
Generate documentation with Doxygen to produce HTML/XML docs from the codebase.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: doxygen Download link: https://github.com/smart-swimmingpool/pool-controller/archive/main.zip#doxygen Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.