Skip to content

rdmsr/cppdoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 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

Preview

There is a live demo available here.

Here is what cppdoc looks like with three different stylesheets:

example/static/light.css: light preview

example/static/ayu.css: ayu preview

example/static/gruvbox.css: gruvbox preview

About

C++ documentation generator

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published