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

qdoc doesn't throw a warning for \generatelist if passed an invalid parameter

    XMLWordPrintable

Details

    • Bug
    • Status: Open
    • P3: Somewhat important
    • Resolution: Unresolved
    • 6.2.6, 6.4.0
    • None
    • None
    • DaVinci 66

    Description

      https://doc.qt.io/QtAndroidAutomotive-6.4/qtaa-examples.html#hvac-control

      is created by passing a group name to \generatelist. the expected behavior was to be the same as using \annotatedlist but with no annotation. there was no warning thrown.

      What was generated looked like this was occurring, but actually, they are not links to the documentation entities they are just targets on the HTML page.

       

      So the first line of the \generatelist command documentation could become "The \generatelist command expands to a list of links to documentation entities depending on the parameter passed."

      and the code was updated to catch this misuse and throw a warning.

      Alternatively, this implied feature could be implemented. 

       

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            docinfrastructure Documentation Infrastructure Team
            nick_bennett Nicholas Bennett
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes