# cppdoc

**Repository Path**: L_MH/cppdoc

## Basic Information

- **Project Name**: cppdoc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-05
- **Last Updated**: 2024-12-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cppdoc 
cppdoc is a C++ documentation generator inspired by `rustdoc`

## Features
- `rustdoc`-like documentation comments, rendered using markdown
- Documentation tests using codeblocks
- Extra pages written in markdown
- [Mermaid](https://mermaid.js.org) graphs
- Flexible styling options with user-supplied stylesheets (see default themes in `example/`)
- libclang-based parser with support for records, enums, functions and namespaces
- Decent performance, with generation usually being faster than libclang-backed Doxygen

## Usage
See [USAGE.md](USAGE.md)

## Preview
There is a live demo available [here](https://rdmsr.github.io/cppdoc).

Here is what cppdoc looks like with three different stylesheets:

`example/static/light.css`:
![light preview](assets/light-preview.png)

`example/static/ayu.css`:
![ayu preview](assets/ayu-preview.png)

`example/static/gruvbox.css`:
![gruvbox preview](assets/gruvbox-preview.png)