diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2024-01-19 09:07:22 +0100 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2024-01-19 18:11:03 +0000 |
| commit | 0407d3e3008d8e26b8195e75ff1ad6f5fd50350e (patch) | |
| tree | 0e37d0624874ff410541b50d70bb71ebee25abf7 | |
| parent | bb812332843939c6e0f28e83a0468a3fe90fa02c (diff) | |
QDoc: Minor fixes in the QDoc manual
The QDoc manual contains incorrect syntax for the use of QDoc's
`extraimages` configuration variable. This change corrects the mistake.
As "drive-by" change, the surrounding text is modified to make it
clearer.
Inspecting the documentation for the `stylesheets` and `scripts`
configuration variables (they're mentioned in the bug report) exposed
another oddity in the manual, which is also addressed herein.
Pick-to: 6.6 6.5
Fixes: QTBUG-121226
Change-Id: I94e37b29de20dc932a2de532d6e5a4f4a7d36512
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
(cherry picked from commit 55bf738c007582ce771bc10ce45298f6d68375f9)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/qdoc/qdoc/doc/qdoc-guide/qdoc-guide.qdoc | 2 | ||||
| -rw-r--r-- | src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc | 22 |
2 files changed, 10 insertions, 14 deletions
diff --git a/src/qdoc/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/qdoc/qdoc/doc/qdoc-guide/qdoc-guide.qdoc index 999aec606..9bf6aa63a 100644 --- a/src/qdoc/qdoc/doc/qdoc-guide/qdoc-guide.qdoc +++ b/src/qdoc/qdoc/doc/qdoc-guide/qdoc-guide.qdoc @@ -176,7 +176,7 @@ The \c{HTML.headerstyles} variable inserts the style information into the HTML file and the \c{HTML.stylesheets} specifies which files QDoc should - copy into the output directory. As well, QDoc will embed the string + copy into the output directory. In addition, QDoc will embed the string in the \c postheader, \c footer, and related variables into each HTML file. The \l {Format-specific Configuration Variables} article outlines the usage diff --git a/src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc b/src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc index a3a4b7dec..c5361053f 100644 --- a/src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc +++ b/src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc @@ -527,23 +527,19 @@ The \c extraimages variable tells QDoc to incorporate specific images in the generated documentation. - QDoc will not recognize images used within HTML (or any other - markup language). If we want the images to be copied from the - directories specified by \l {imagedirs} {\c imagedirs} (the images - in question must be located in these directories) to the output - directory, we must specify the images using the \c extraimages - variable. + QDoc automatically copies an image file from \l imagedirs to the output + directory if it's referenced by the \l {image-command} {\c{\image}} or + \l {inlineimage-command} {\c{\inlineimage}} command. If you want to copy + additional images, you must specify them using the \c extraimages variable. - The general syntax is \tt {extraimages.\e{format} = \e image}. The - file extension is optional. + The general syntax is \tt {\e{format}.extraimages = \e image}. - For example, in \l qtgui.qdocconf we use a couple of images within - the HTML.postheader variable which value is pure HTML. For that - reason, these images are specified using the \c extraimages - variable: + For a contextualized example, refer to the description of the + \l {HTML.postheader-variable}{HTML.postheader} variable. + Example: \badcode - extraimages.HTML = qt-logo + HTML.extraimages = images/qt-logo.png \endcode See also \l images and \l imagedirs. |