[flang-commits] [flang] [flang][docs] Fix text and links in doxygen landing page (PR #172582)
Tarun Prabhu via flang-commits
flang-commits at lists.llvm.org
Wed Dec 17 08:23:58 PST 2025
https://github.com/tarunprabhu updated https://github.com/llvm/llvm-project/pull/172582
>From b7a26481ff157135c7c5ec0695d68a1640c028cb Mon Sep 17 00:00:00 2001
From: Tarun Prabhu <tarun.prabhu at gmail.com>
Date: Tue, 16 Dec 2025 18:29:05 -0700
Subject: [PATCH] [flang][docs] Fix text and links in the doxygen landing page
The link in the doxygen landing page in flang was broken. This has been replaced
with a link to the "Using Flang" section of the main documentation. The text on
the landing page has also been tweaked to be a bit more "sober".
---
flang/docs/doxygen-mainpage.dox | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
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