[flang-commits] [flang] e128c46 - [flang][docs] Fix text and links in doxygen landing page
via flang-commits
flang-commits at lists.llvm.org
Wed Dec 17 09:24:02 PST 2025
Author: Tarun Prabhu
Date: 2025-12-17T10:23:57-07:00
New Revision: e128c4612fc2ba0b05da4d79d9a369df5bc3461d
URL: https://github.com/llvm/llvm-project/commit/e128c4612fc2ba0b05da4d79d9a369df5bc3461d
DIFF: https://github.com/llvm/llvm-project/commit/e128c4612fc2ba0b05da4d79d9a369df5bc3461d.diff
LOG: [flang][docs] Fix text and links in doxygen landing page
The link to the project website in the doxygen landing page was broken.
This has been replaced with a link to the "Using Flang" section of the
main documentation. The text has also been tweaked to be a bit more
"sober".
Added:
Modified:
flang/docs/doxygen-mainpage.dox
Removed:
################################################################################
diff --git a/flang/docs/doxygen-mainpage.dox b/flang/docs/doxygen-mainpage.dox
index e4bc3f6602425..216f75353d88d 100644
--- a/flang/docs/doxygen-mainpage.dox
+++ b/flang/docs/doxygen-mainpage.dox
@@ -3,13 +3,13 @@
/// \section main_intro Introduction
/// Welcome to the flang project.
///
-/// This documentation describes the **internal** software that makes
-/// up flang, not the **external** use of flang. There are no instructions
+/// The documentation here describes the **internal** software that makes
+/// up flang. There are no instructions
/// here on how to use flang, only the APIs that make up the software. For
-/// usage instructions, please see the [project website](https://github.com/llvm-project/flang)
-/// for further detail.
+/// usage instructions, please consult flang's
+/// [user documentation](https://flang.llvm.org/docs/#using-flang).
///
/// \section main_caveat Caveat
/// This documentation is generated directly from the source code with doxygen.
-/// Since flang is constantly under active development, what you're about to
-/// read is out of date!
+/// Since flang is under active development, some of what you're about to read
+/// may already be out of date.
More information about the flang-commits
mailing list