xref: /llvm-project/flang/docs/doxygen-mainpage.dox (revision 2e1827271cb1c090cced7369282f9edcf9e59183)
1807fe05dSsameeran joshi/// \mainpage flang
2807fe05dSsameeran joshi///
3807fe05dSsameeran joshi/// \section main_intro Introduction
4807fe05dSsameeran joshi/// Welcome to the flang project.
5807fe05dSsameeran joshi///
6807fe05dSsameeran joshi/// This documentation describes the **internal** software that makes
7807fe05dSsameeran joshi/// up flang, not the **external** use of flang. There are no instructions
8807fe05dSsameeran joshi/// here on how to use flang, only the APIs that make up the software. For
9*2e182727SRichard Barton/// usage instructions, please see the [project website](https://github.com/llvm-project/flang)
10807fe05dSsameeran joshi/// for further detail.
11807fe05dSsameeran joshi///
12807fe05dSsameeran joshi/// \section main_caveat Caveat
13807fe05dSsameeran joshi/// This documentation is generated directly from the source code with doxygen.
14807fe05dSsameeran joshi/// Since flang is constantly under active development, what you're about to
15807fe05dSsameeran joshi/// read is out of date!
16