skills.rest
darshan3v
darshan3vCOMMUNITY
Explore all skills by this author →
𝕏@darshanv3vGitHub

ODAI Documentation Guidelines

Enforce Doxygen-style documentation standards for C++ code in the ODAI SDK.

2|1|Updated Jan 13, 2026
Search Tags:#documentation#coding standards#sdk#guidelines#cpp#doxygen
One-click install
npx skills add https://github.com/darshan3v/odai --skill odai-documentation-guidelines
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ODAI Documentation Guidelines
Source: https://github.com/darshan3v/odai/tree/main/.agent/skills/odai_documentation_guide
Command: npx skills add https://github.com/darshan3v/odai --skill odai-documentation-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about ODAI Documentation Guidelines

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

FAQPage Schema
How do I document C++ functions in Doxygen style for SDK development?▼

To document C++ functions in Doxygen style, use /// comments and include brief summaries, @param for parameters, and @return for return values. This ensures SDK code maintainability and clarity through consistent documentation practices.

What should be included in C++ Doxygen comments for edge cases and error conditions?▼

Doxygen comments for edge cases and error conditions should document specific failure scenarios and boundary behaviors alongside required brief summaries, parameter descriptions, and return value explanations to ensure complete code clarity.

What is the best way to standardize C++ documentation across an SDK codebase?▼

Standardizing C++ documentation across an SDK involves enforcing Doxygen-style rules mandating /// comments, structured @param and @return tags, and consistent brief summaries to achieve uniform codebase maintainability.

Can I use block comments instead of /// for Doxygen-style C++ documentation?▼

No, Doxygen-style C++ documentation for the ODAI SDK mandates the use of /// for all documentation comments rather than block comments to maintain strict consistency across the codebase.

When do I need to document return values in C++ SDK code?▼

You need to document return values in C++ SDK code whenever a function produces an output, using the @return tag to explain the return value and any relevant error conditions or edge cases.

Does the ODAI documentation guidelines Skill support languages other than C++?▼

No, the ODAI documentation guidelines Skill enforces Doxygen-style documentation standards specifically for C++ code within the ODAI SDK and does not support other programming languages.

Related Skills

Explore More Software Engineering Skills→
smart-swimmingpoolsmart-swimmingpool
25

doxygen

Enforce Doxygen inline documentation standards for C++ header and source files.

Official
Advanced
Sun-Lab-NBBSun-Lab-NBB
3

cpp-style

Apply Sun Lab C++ coding conventions to source files.

Official
Advanced
pontschopontscho
1

p:c-cpp-guidelines

Enforce C/C++ coding best practices for memory management, documentation, and static analysis.

Community
Intermediate
kleon6436kleon6436

cpp-coding-standards

Enforce modern C++ coding standards for C++17/20 features and RAII.

Community
Advanced