xref: /llvm-project/clang/docs/doxygen-mainpage.dox (revision a079856a5134f0f79bf8a536be002df8d972c677)
1*a079856aSAlexander Kornienko/// \mainpage clang
2*a079856aSAlexander Kornienko///
3*a079856aSAlexander Kornienko/// \section main_intro Introduction
4*a079856aSAlexander Kornienko/// Welcome to the clang project.
5*a079856aSAlexander Kornienko///
6*a079856aSAlexander Kornienko/// This documentation describes the **internal** software that makes
7*a079856aSAlexander Kornienko/// up clang, not the **external** use of clang. There are no instructions
8*a079856aSAlexander Kornienko/// here on how to use clang, only the APIs that make up the software. For
9*a079856aSAlexander Kornienko/// usage instructions, please see the programmer's guide or reference
10*a079856aSAlexander Kornienko/// manual.
11*a079856aSAlexander Kornienko///
12*a079856aSAlexander Kornienko/// \section main_caveat Caveat
13*a079856aSAlexander Kornienko/// This documentation is generated directly from the source code with doxygen.
14*a079856aSAlexander Kornienko/// Since clang is constantly under active development, what you're about to
15*a079856aSAlexander Kornienko/// read is out of date!
16