orpheus.doc.gen

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'.