OpenParable
Skip to content
← Back to skills

Sqlitecpp Doxygen Guide

Development
sqlitecpp-doxygen-guide

Sqlitecpp Doxygen Guide is an Agent Skill for development published in the SRombauts/SQLiteCpp repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

SQLiteCpp Doxygen standards and templates for public API docs and file headers.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/SRombauts/SQLiteCpp/blob/HEAD/.claude/skills/sqlitecpp-doxygen-guide/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/sqlitecpp-doxygen-guide, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

SQLiteCpp Doxygen Guide

For general style rules, see AGENTS.md and sqlitecpp-coding-standards.

Scope

  • Doxygen runs on both include/ and src/ (see Doxyfile).
  • Public API must be documented in headers.
  • Source files still use Doxygen file headers.

Basic Example (Format Only)

/**
 * @file    Example.h
 * @ingroup SQLiteCpp
 * @brief   One-line summary of the file.
 */
class SQLITECPP_API Example
{
public:
    /**
     * @brief Do the thing.
     * @param[in] aValue  Value to use
     * @return Result value
     * @throw SQLite::Exception in case of error
     */
    int doThing(int aValue);
};

Keep the full MIT license block in real file headers.

Canonical Examples (Use These)

  • File header + class + methods: include/SQLiteCpp/Database.h
  • File header in src/: src/Database.cpp

File Header Rules

  • Keep @file, @ingroup, @brief.
  • Keep the MIT license block and copyright line.
  • Keep #pragma once in headers.
  • Match the existing header of the file you edit.

API Comment Rules

  • @brief for every public class/method.
  • @param[in|out] for each parameter.
  • @return for non-void return values.
  • @throw SQLite::Exception for throwing APIs.
  • Use @note/@warning only when needed.

Generate Docs

cmake -DSQLITECPP_RUN_DOXYGEN=ON ..
cmake --build . --target SQLiteCpp_doxygen

Output: doc/html/index.html

Cross-References

  • Workflow checklist: see sqlitecpp-workflow