Details
-
Bug
-
Resolution: Done
-
P2: Important
-
5.4.0 Beta
-
None
Description
The following issues might cause an example to disappear from the Qt Creator Help mode Examples tab:
- examplesinstallpath is missing from the .qdocconf file for the module. It sets the example installation directory under QT_INSTALL_EXAMPLES
- the \brief command is missing from the example documentation
- an \image is missing from the example documentation
- the examples are not in one folder within the module
To see the broken examples:
1) Start Qt Creator with the following CLI command:
QTC_DEBUG_EXAMPLESMODEL=1 ./qtcreator 2> errors.log
(QTC_DEBUG_EXAMPLESMODEL=1 "Qt Creator.app/Contents/MacOS/Qt Creator" 2> errors.log on OS X)
2) Select Help > Examples > 5.4
3) Search for "broken"
Attachments
Issue Links
- is required for
-
QTBUG-43865 Qt 5.5 Documentation Issues [meta]
- Closed
- relates to
-
QTBUG-41963 Fix invalid paths in Qt Core example manifest files
- Closed