Light

ukilele / mrdox Goto Github PK

View Code? Open in Web Editor NEW

This project forked from cppalliance/mrdocs

0.0 0.0 0.0 1.02 MB

MrDox: A Clang/LLVM tool for building reference documentation from C++ code and javadoc comments.

License: Other

C++ 95.90% CMake 2.78% Python 1.32%

mrdox's Introduction

Mr. Dox

Install

This library depends on a recent version of LLVM. Here are the instructions to install LLVM with the settings required by this project.

git clone https://github.com/llvm/llvm-project.git
cd llvm-project
git checkout 731264b0c2af7aa46bd39625202a99e06cfccff9
cmake -S llvm -B build -D LLVM_ENABLE_PROJECTS="clang;clang-tools-extra" -D CMAKE_BUILD_TYPE=Release -D LLVM_ENABLE_RTTI=ON -D CMAKE_INSTALL_PREFIX=/path/to/llvm+clang
cd build
cmake --build . -j <threads>
cmake --install .

Once LLVM is available in /path/to/llvm+clang, you can build and install mrdox with:

git clone https://github.com/cppalliance/mrdox
cd mrdox
cmake -S . -B build -D CMAKE_BUILD_TYPE=Release -D LLVM_ROOT=/path/to/llvm+clang -D Clang_ROOT=/path/to/llvm+clang
cd build
cmake --build . -j <threads>
cmake --install .

Comparison

Doxygen:

tries to work for many languages
use the inferior libclang API
old program with lots of technical debt
not written by me

MrDox:

narrow and deep focus on C++ only
uses clang’s unstable libtooling API:
- Understands ALL C++: if clang can compile it, MrDox knows about it
- This includes up to C++20 and even experimental things in C++23
brand-new program with no technical debt
written by me

mrdox's People

Contributors

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.