Skip to main content

clang based documentation generator for C/C++

Project description

cldoc is a clang based documentation generator for C and C++. cldoc tries to
solve the issue of writing C/C++ software documentation with a modern,
non-intrusive and robust approach.

# Features
* Uses clang to robustly parse even the most complex C++ projects without
additional effort from the user.
* Requires zero configuration.
* Uses markdown for documentation formatting.
* Generates an xml description of the API which can be reused for other purposes.
* Uses a simple format for documenting your code.
* Supports cross-referencing in documentation.
* Generates a single file, javascript based web application to render the documentation.
* Integrates seamlessly with your existing website.
* Lightning fast client-side searching using a pregenerated search index.
* Generates a formatted documentation coverage report and integrates it in the

For more information, please visit

# Get started now!
To get started using cldoc, please have a look at
[Getting started]( to install cldoc. Then explore how
to [document your code]( so that cldoc can extract it. Finally
go and read [Generating site]( to find out how to use the cldoc
command in your project to generate the documentation.

# Example
For an easy introduction into using cldoc, please have a look at the
[example project]( and corresponding
generated [documentation](

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cldoc-1.4.tar.gz (165.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page