Menu
SQLiteCpp Doxygen standards and templates for public API docs and file headers.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | sqlitecpp-doxygen-guide |
| description | SQLiteCpp Doxygen standards and templates for public API docs and file headers. |
For general style rules, see
AGENTS.mdandsqlitecpp-coding-standards.
include/ and src/ (see Doxyfile)./**
* @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.
include/SQLiteCpp/Database.hsrc/: src/Database.cpp@file, @ingroup, @brief.#pragma once in headers.@brief for every public class/method.@param[in|out] for each parameter.@return for non-void return values.@throw SQLite::Exception for throwing APIs.@note/@warning only when needed.cmake -DSQLITECPP_RUN_DOXYGEN=ON ..
cmake --build . --target SQLiteCpp_doxygen
Output: doc/html/index.html
sqlitecpp-workflowSQLiteCpp CI workflow patterns. Use for GitHub Actions, AppVeyor, Travis, matrices, or test steps.
Running shell commands on this Windows checkout via the PowerShell and Bash tools, and passing multi-line or quoted arguments (commit messages, PR bodies, file content) without corruption. Use when running git or gh with multi-line or quoted input, writing a commit message or PR body from the command line, reaching for a heredoc or here-string, or after a message or body comes out wrapped in stray characters such as a leading and trailing `@`.
SQLiteCpp change workflow checklists for API, tests, build files, and CHANGELOG updates. Use when adding a method or class, editing build files, or writing a CHANGELOG entry for a PR.
SQLiteCpp coding standards and API rules for core edits, public headers, style, and Doxygen.
Default response behavior for AI coding agents: professional, factual, neutral tone with calibrated critical evaluation. Baseline for every task: implementation, code review, debugging, planning, research, evaluation, Q&A.
Editing conventions for files under `.claude/skills/**` (markdown style, frontmatter format, SKILL.md vs `references/` split, upstream-vendored skills). Use when creating a new skill, editing any `SKILL.md` or `references/*.md` file, refactoring a skill description, or after adding/removing a skill.