cpp-api-documentation

Document public C++ header APIs by adding inline Doxygen-style comments to .hpp/.h files.

3|2|Updated Feb 6, 2026
One-click install
npx skills add https://github.com/sentenz/skills --skill cpp-api-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cpp-api-documentation
Source: https://github.com/sentenz/skills/tree/main/skills/cpp-api-documentation
Command: npx skills add https://github.com/sentenz/skills --skill cpp-api-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It simplifies improving API visibility by embedding Doxygen-style comments directly into existing C++ header files, eliminating drift between implementation and documentation.

Core Features & Use Cases

  • Inline Doxygen documentation for headers (*.hpp, *.h) to describe classes, functions, and parameters
  • Keeps code structure intact while boosting API discoverability for downstream users
  • Use case: upgrade an aging library's API docs without modifying source beyond headers

Quick Start

Identify public headers in your project and annotate them with Doxygen-compatible comments to document classes, functions, and parameters.

Frequently Asked Questions about cpp-api-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add Doxygen-style comments to existing C++ header files?

You can document C++ header APIs by adding Doxygen-style comments directly into existing *.hpp and *.h files. This approach annotates namespaces, classes, and functions inline, keeping code structure intact without generating external Doxyfile resources.

What is the best way to document C++ library APIs without causing documentation drift?

The best way to prevent documentation drift in C++ libraries is to embed Doxygen-style comments directly within header files. This inline annotation method ensures the implementation and API documentation stay synchronized in the src and include directories.

Can I generate Doxygen documentation for C++ headers without creating new resource files?

Yes, you can document C++ APIs without creating new resource files by enforcing inline templates directly within existing headers. The workflow focuses strictly on annotating code in *.hpp and *.h files rather than generating external scripts or Doxyfiles.

Does this inline commenting approach modify source files beyond C++ headers?

No, this inline commenting approach restricts modifications strictly to C++ header files (*.hpp and *.h). It boosts API discoverability by annotating headers within src and include directories while keeping the underlying source code structure intact.

When do I need inline Doxygen comments for C++ header files?

You need inline Doxygen comments for C++ header files when upgrading an aging library's API documentation. This approach improves API visibility by embedding parameter and function descriptions directly into the public headers.