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

Misleading rendering of Class(std::initializer_list<V>) where V is a nested type alias

    XMLWordPrintable

Details

    • Bug
    • Resolution: Unresolved
    • P3: Somewhat important
    • None
    • 6.8.0
    • Build tools: qdoc
    • None

    Description

      Example: https://doc.qt.io/qt-6/qspan.html#QSpan-8 (in case the link changed in the meantime: this is the initializer_list ctor of QSpan).

      Source:

      \fn template <typename T, size_t E> QSpan<T, E>::QSpan(std::initializer_list<value_type> il);
      

      Result:

      QSpan::QSpan(std::initializer_list<QSpan<T, E>::value_type>)
      

      This can be very easily misread (I did so) as meaning initializer_list of some QSpan, when in fact, it's just initializer_list<value_type>.

      Expected rendering:

      QSpan::QSpan(std::initializer_list<value_type>)
      

      (and value_type should be a link to the value_type docs).

      Attachments

        Issue Links

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

          Activity

            People

              docinfrastructure Documentation Infrastructure Team
              mmutz Marc Mutz
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes