maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/bolt/docs/doxygen-mainpage.dox

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

16 lines
619 B
Plaintext
Raw Normal View History

[BOLT][DOCS] Build doxygen documentation Summary: Added doxygen configuration files and CMake directives, copy-pasta from flang. ```cmake -G Ninja ../llvm-project/llvm \ -DLLVM_ENABLE_PROJECTS="bolt" \ -DBOLT_INCLUDE_DOCS=YES \ -DLLVM_ENABLE_DOXYGEN=YES ninja doxygen-bolt ``` (cherry picked from FBD33303249)
2021-12-24 07:23:39 +08:00
/// \mainpage BOLT
///
/// \section main_intro Introduction
/// Welcome to the BOLT project.
///
/// This documentation describes the **internal** software that makes
/// up BOLT, not the **external** use of BOLT. There are no instructions
/// here on how to use BOLT, only the APIs that make up the software. For
[BOLT][DOCS] Link to README instead of the github page in Doxygen Summary: Link to the README page built with the rest of the documentation, a future-proof solution. (cherry picked from FBD33357870)
2021-12-30 09:38:06 +08:00
/// usage instructions, please see the [README](@ref md_README) for further
/// detail.
[BOLT][DOCS] Build doxygen documentation Summary: Added doxygen configuration files and CMake directives, copy-pasta from flang. ```cmake -G Ninja ../llvm-project/llvm \ -DLLVM_ENABLE_PROJECTS="bolt" \ -DBOLT_INCLUDE_DOCS=YES \ -DLLVM_ENABLE_DOXYGEN=YES ninja doxygen-bolt ``` (cherry picked from FBD33303249)
2021-12-24 07:23:39 +08:00
///
/// \section main_caveat Caveat
/// This documentation is generated directly from the source code with doxygen.
/// Since BOLT is constantly under active development, what you're about to
/// read is out of date!