]> granicus.if.org Git - clang/commitdiff
[docs] Add missing file
authorAlexander Kornienko <alexfh@google.com>
Thu, 3 Mar 2016 10:44:10 +0000 (10:44 +0000)
committerAlexander Kornienko <alexfh@google.com>
Thu, 3 Mar 2016 10:44:10 +0000 (10:44 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@262604 91177308-0d34-0410-b5e6-96231b3b80d8

docs/doxygen-mainpage.dox [new file with mode: 0644]

diff --git a/docs/doxygen-mainpage.dox b/docs/doxygen-mainpage.dox
new file mode 100644 (file)
index 0000000..2fd34f0
--- /dev/null
@@ -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!