From aecf79e838ed039e749b6e76503bf8f49d59258d Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@qt.io>
Date: Wed, 14 Feb 2018 09:57:43 +0100
Subject: [PATCH] doc: Warn users about qdoc's clang dependency
From Qt 5.11, QDoc requires clang from LLVM 3.9 or later.
This new dependency must be listed in the Qt documentation.
This update adds a note to the Getting Started with Qt page
that refers the user to the QDoc manual for further instructions.
Change-Id: Ia308400c855d19b6391d9239ab74b060e931cd50
Task-number: QTBUG-65762
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
---
doc/src/getting-started/gettingstarted.qdoc | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/doc/src/getting-started/gettingstarted.qdoc b/doc/src/getting-started/gettingstarted.qdoc
index c732da67..e12441c3 100644
--- a/doc/src/getting-started/gettingstarted.qdoc
+++ b/doc/src/getting-started/gettingstarted.qdoc
@@ -76,6 +76,13 @@
Use the Maintenance Tool under \e{<install_dir>} to add components and to
update or remove installed components.
+ \note From Qt 5.11, \l{QDoc Manual}{QDoc}, the Qt documentation generation
+ tool, requires \l{http://clang.llvm.org}{clang} from LLVM 3.9 or greater for
+ parsing C++ code. If you intend to use \l{QDoc Manual}{QDoc} to generate
+ documentation for your own projects, or if you intend to build the Qt
+ documentation locally from your Qt sources, see \l{Getting Started with QDoc}
+ for details.
+
\section2 Platform Requirements
Developing applications on different platforms are covered in the platform
--
GitLab