Added a configuration variable for the QML documentation file prefix.

This required a certain amount of refactoring to make the new
variable visible to the relevant parts of the code. I also moved
the fullDocumentLocation() function into the HtmlGenerator class,
where it belongs.

Task-number: QTBUG-17071

1 files changed, 21 insertions, 0 deletions

diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index adf92fe..7290c0e 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -7069,6 +7069,8 @@
     \l {22-qdoc-configuration-generalvariables.html#outputdir}{outputdir},
     \l {22-qdoc-configuration-generalvariables.html#outputformats}
        {outputformats},
+    \l {22-qdoc-configuration-generalvariables.html#outputprefixes}
+       {outputprefixes},
     \l {22-qdoc-configuration-generalvariables.html#slow}{slow},
     \l {22-qdoc-configuration-generalvariables.html#sourcedirs}{sourcedirs},
     \l {22-qdoc-configuration-generalvariables.html#sources}{sources},
@@ -7155,6 +7157,8 @@
     \l {22-qdoc-configuration-generalvariables.html#outputdir}{outputdir},
     \l {22-qdoc-configuration-generalvariables.html#outputformats}
        {outputformats},
+    \l {22-qdoc-configuration-generalvariables.html#outputprefixes}
+       {outputprefixes},
     \l {22-qdoc-configuration-generalvariables.html#slow}{slow},
     \l {22-qdoc-configuration-generalvariables.html#sourcedirs}{sourcedirs},
     \l {22-qdoc-configuration-generalvariables.html#sources}{sources},
@@ -7796,6 +7800,23 @@
            the default format, and doesn't need to be specified.
 
     \row
+        \o \bold outputprefixes \target outputprefixes
+        \o \bold {The \c outputprefixes variable specifies a mapping between
+           types of files and the prefixes to prepend to the HTML file names
+           in the generated documentation.}
+
+           For example:
+
+           \code
+           outputprefixes = QML
+           outputprefixes.QML = qt-components-
+           \endcode
+
+           Be default, files containing the API documentation for QML elements
+           or components are prefixed with "qml-". In the above example, the
+           prefix "qt-components-" is used instead.
+
+    \row
         \o \bold qhp \target qhp
         \o \bold{The \c qhp variable is used to define the information to be
            written out to Qt Help Project (\c{qhp}) files.}