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

Restore default values for functions from index files

XMLWordPrintable

    • 5fc84459fa707a5b5fff5838eb70ba5f3e473bf5

      The way that QDoc currently generates documentation for a module involves parsing C++ code during both the prepare and generate runs of QDoc. Information about default parameter values is recovered during both steps and used in the generated documentation. Although information about default values is not retrieved from the index files (since parsing occurs during the generate run) there is one place where this missing information leads to incomplete documentation.

      The New Classes and Functions pages lack information about default values for function parameters because they are located in the qtdoc module which needs information from the index files of other modules. This is not necessarily a problem because the API pages themselves should contain the full signatures for new functions.

      However, with a version of QDoc that only parses C++ code during the prepare run and uses index files to reconstruct the API during the generate run, the default values need to be read from the index file for all modules. A change that implements this behavior also fixes the New Classes and Functions pages as a side effect.

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

            david.boddie David Boddie
            david.boddie David Boddie
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:

                There are no open Gerrit changes