ODAI Documentation Guidelines

What problem does it solve?

This Skill ensures consistent and high-quality documentation across the ODAI SDK by providing clear style rules and a checklist for developers.

Core Features & Use Cases

• Doxygen Style Enforcement: Mandates the use of /// for all documentation comments.
• Structured Documentation: Requires specific elements like brief summaries, parameter descriptions (@param), and return value explanations (@return).
• Use Case: When documenting a new C++ function for the ODAI SDK, developers can refer to these guidelines to ensure their comments are clear, complete, and follow the established standard, making the codebase easier to understand and maintain.

Quick Start

Follow the Doxygen-style comment guidelines for all new code documentation.