diff options
author | Dimitry Andric <dim@FreeBSD.org> | 2016-07-23 20:44:14 +0000 |
---|---|---|
committer | Dimitry Andric <dim@FreeBSD.org> | 2016-07-23 20:44:14 +0000 |
commit | 2b6b257f4e5503a7a2675bdb8735693db769f75c (patch) | |
tree | e85e046ae7003fe3bcc8b5454cd0fa3f7407b470 /docs/doxygen-mainpage.dox | |
parent | b4348ed0b7e90c0831b925fbee00b5f179a99796 (diff) |
Notes
Diffstat (limited to 'docs/doxygen-mainpage.dox')
-rw-r--r-- | docs/doxygen-mainpage.dox | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/doxygen-mainpage.dox b/docs/doxygen-mainpage.dox new file mode 100644 index 000000000000..2fd34f04de7a --- /dev/null +++ b/docs/doxygen-mainpage.dox @@ -0,0 +1,15 @@ +/// \mainpage clang +/// +/// \section main_intro Introduction +/// Welcome to the clang project. +/// +/// This documentation describes the **internal** software that makes +/// up clang, not the **external** use of clang. There are no instructions +/// here on how to use clang, only the APIs that make up the software. For +/// usage instructions, please see the programmer's guide or reference +/// manual. +/// +/// \section main_caveat Caveat +/// This documentation is generated directly from the source code with doxygen. +/// Since clang is constantly under active development, what you're about to +/// read is out of date! |