Merge remote-tracking branch 'origin/5.15' into 5.15.0

Change-Id: I1fdd80c6b7c2615815acc262f01a3893d28406a3

1 files changed, 9 insertions, 5 deletions

diff --git a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
index c964493bc..f1e602dc2 100644
--- a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
+++ b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
@@ -37,7 +37,7 @@
     \l{writing-markup}{mark up} to enhance the layout and formatting of the
     final output.
 
-    There are three essential materials for generating documentation with qdoc:
+    There are three essential materials for generating documentation with QDoc:
     \list
         \li \c QDoc binary
         \li \c qdocconf configuration files
@@ -95,12 +95,12 @@
     can style the documentation in DITA at a later time. DITA XML is therefore
     more flexible in allowing different styles to apply to the same information.
 
-    To run qdoc, the project configuration file is supplied as an argument.
+    To run QDoc, the project configuration file is supplied as an argument.
     \code
     qdoc project.qdocconf
     \endcode
 
-    The project configuration contains information that qdoc uses to create the
+    The project configuration contains information that QDoc uses to create the
     documentation.
 
     \section2 Project Information
@@ -267,7 +267,7 @@
     comment; the comment itself and anything after it, until a newline,
     is omitted from the generated output.
 
-    QDoc will parse C++ and QML files to look for qdoc comments. To explicitly
+    QDoc will parse C++ and QML files to look for QDoc comments. To explicitly
     omit a certain file type, omit it from the
     \l{Input and Output Directories}{configuration} file.
 
@@ -280,7 +280,7 @@
 
     \target writing-topic-commands
     \section2 QDoc Topics
-    Each qdoc comment must have a \e topic type. A topic distinguishes it from
+    Each QDoc comment must have a \e topic type. A topic distinguishes it from
     other topics. To specify a topic type, use one of the several
     \l{Topic Commands}{topic commands}.
 
@@ -638,6 +638,10 @@
     install the \c libclang-dev package and its dependencies. For running QDoc,
     the \c libclang package is required.
 
+    \note On Windows, after installing the pre-built LLVM you must restart your
+    build shell to ensure that LLVM's binary directory is added to the PATH
+    variable. This is needed to be able to run qdoc.
+
     \section1 Set Clang location automatically
 
     The Qt build system uses the tool \c llvm-config to discover the location