Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-41996

Qt Creator tags some examples as "broken"

    XMLWordPrintable

Details

    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

          For Gerrit Dashboard: QTBUG-41996
          # Subject Branch Project Status CR V

          Activity

            People

              veshivas Venugopal Shivashankar
              leenam Leena Miettinen
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: