orpheus.doc.gen

Generate Doxygen comments and Markdown documentation for the Orpheus SDK.

Updated Aug 9, 2025
One-click install
npx skills add https://github.com/chrislyons/orpheus-sdk --skill orpheus-doc-gen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: orpheus.doc.gen
Source: https://github.com/chrislyons/orpheus-sdk/tree/main/.claude/skills/project/orpheus-doc-gen
Command: npx skills add https://github.com/chrislyons/orpheus-sdk --skill orpheus-doc-gen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintaining up-to-date and consistent documentation is a constant challenge, especially for complex SDKs. This skill automates the generation and maintenance of various documentation types, from Doxygen comments to progress reports, ensuring high-quality, standardized project knowledge without manual effort.

Core Features & Use Cases

  • Doxygen Comment Generation: Automatically creates Doxygen-compliant comments for C++ functions and classes, including parameter, return, and real-time safety annotations.
  • Progress & Session Reports: Generates structured Markdown reports to track project progress, session accomplishments, and technical decisions.
  • Documentation Consistency: Enforces a consistent style and includes critical details like thread-safety and real-time safety for all APIs.
  • Use Case: After implementing a new C++ class, simply ask this skill to generate Doxygen comments for its public interface. It will produce well-formatted, comprehensive documentation, saving you hours of tedious writing and ensuring all critical details are covered.

Quick Start

Generate Doxygen comments for the processBlock function in the attached C++ file 'audio_processor.h'.

Frequently Asked Questions about orpheus.doc.gen

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

FAQPage Schema
How do I automatically generate Doxygen comments for C++ functions and classes?

Doxygen comment generation automates creation of standardized documentation for C++ code. This skill reads your source files and produces Doxygen-compliant comments with parameter, return, and safety annotations, eliminating manual writing while ensuring consistency across your API.

Can I automate documentation for an API after implementing new public methods?

Yes. After adding new C++ APIs, this skill reads the updated source code and generates comprehensive API reference documents, Doxygen comments, and Markdown reports in a single pass, keeping your documentation synchronized with code changes.

What documentation formats does this skill produce?

This skill produces Doxygen-compliant comments for C++ code, Markdown progress reports tracking implementation milestones, session notes documenting technical decisions, and API reference documents. All outputs enforce ORP/OCC naming conventions and include real-time and thread-safety annotations.

How do I ensure documentation includes thread-safety and real-time safety details?

This skill automatically analyzes C++ functions and classes to identify and annotate thread-safety and real-time safety requirements in generated Doxygen comments. It applies critical safety notes to all public APIs without manual review.

Can I use this for progress tracking alongside API documentation?

Yes. Beyond Doxygen comments, this skill generates structured Markdown progress reports and session notes to document project accomplishments, implementation decisions, and technical direction alongside API reference updates.

Does this skill work with existing documentation and code comments?

This skill reads existing documentation and source code as input to maintain consistency. It produces new Doxygen comments and reports that align with your project's established style and naming conventions.