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

\overload command should enable documenting differences more conveniently

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • P2: Important
    • 6.1.0 RC
    • 5.14.1
    • Build tools: qdoc
    • None
    • 58902fbd684d39191fbddf3ef5e917e709b38a68 (qt/qttools/dev)
    • Da Vinci sprint 10

    Description

      Qdoc groups all the functions with the \overload command in a single block and uses the documentation for the first one in the list for the entire set. The challenge now is when you have to document the differences in these overloaded functions, for example, parameters, \since entries, example snippet, and so on. The moment you add additional info. other than the \overload command, qdoc creates a separate function-block for that function with only the additional info., whereas the rest of its counterparts are still shown under a single block. It would ideal, if qdoc can use the documentation for the first one as the base, and append additional info. in the overloaded versions to it.  For example,

      • QString QDateTime::toString(QStringView format) const
      • QString QDateTime::toString(QStringView format, QCalendar cal) const
      • QString QDateTime::toString(const QString &format) const
      • QString QDateTime::toString(const QString &format, QCalendar cal) const

      These functions are added in different versions of Qt, so \since entries will be handy. Moreover, the parameters are different for each of these, so they must be explained.

       

      Attachments

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

        Activity

          People

            treinio Topi Reiniö
            veshivas Venugopal Shivashankar
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes