summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Wicking <paul.wicking@qt.io>2022-08-29 09:06:35 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-08-29 16:58:29 +0000
commit6e8c13fc295b0da28125ec25244102fdb5b1fc29 (patch)
treebb17b561c5e2e74500f27eabf613dd2554d372b2
parent6ede3f1a28482517e39af7f079a9cc6ca0091562 (diff)
QDoc manual: improve Clang for QDoc section
Reflow long lines as part of edit. Change-Id: I73652a5a769918845f16d24a3d8673038f63bb85 Reviewed-by: Luca Di Sera <luca.disera@qt.io> (cherry picked from commit 364c843f67a0bac7b1a4c9112a38c631dd2d4ea5) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc23
1 files changed, 14 insertions, 9 deletions
diff --git a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
index 372813b16..80e059b0c 100644
--- a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
+++ b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
@@ -663,23 +663,28 @@
QDoc uses Clang when parsing C++ files as well as function signatures in
\l {fn-command} {\\fn} commands. Clang is part of
\l {https://llvm.org/}{the LLVM Compiler Infrastructure Project}.
- Therefore, if you are going to build QDoc from source, you need to install
- \l{http://clang.llvm.org}{LLVM 8.0} or greater first.
+ If you're going to build QDoc from source, you must install
+ \l{http://clang.llvm.org}{Clang 8.0} or later.
You can get Clang through various channels:
\list
- \li Qt provides \l{http://download.qt.io/development_releases/prebuilt/libclang/qt}
- {prebuilt Clang packages} that are also used for the Qt binaries in the online
- installer. They allow to link LLVM/clang libraries statically, but only support Release
- builds on Windows.
- \li Linux distributions often provide a package called libclang-dev or libclang-devel.
+ \li Qt provides the
+ \l{http://download.qt.io/development_releases/prebuilt/libclang/qt}
+ {prebuilt Clang packages} that are used for the Qt binaries in the
+ online installer. These let you link LLVM/Clang libraries statically,
+ but only support Release builds on Windows.
+ \li Linux distributions often provide a package called \e libclang-dev or
+ \e libclang-devel. Qt's build system instructs CMake to look for
+ \e {ClangConfig.cmake}, so make sure you install the package that
+ provides this file if you want to build QDoc. Running QDoc requires
+ only \e libclang.
\li On macOS, you can also use Homebrew's
\l{https://formulae.brew.sh/formula/llvm}{llvm formula}.
\endlist
- \note the prebuilt binaries from \l{http://releases.llvm.org/download.html} cannot
- be used, as they miss certain components required by QDoc.
+ \note the prebuilt binaries from \l{http://releases.llvm.org/download.html}
+ cannot be used, as they miss certain components required by QDoc.
If you install Clang in a custom location you need to tell CMake where
to find it. This can be done by adding the installation path to