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

Wrong documentation generated for some QDate(Time) methods

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: P2: Important
    • Resolution: Fixed
    • Affects Version/s: 6.4
    • Fix Version/s: None
    • Labels:
      None
    • Sprint:
      DaVinci sprint 54, DaVinci 55, DaVinci 56, DaVinci 57

      Description

      A few recent patches added functions to QDate and QDateTime, but the documentation that qdoc generates is wrong.

      This patch https://codereview.qt-project.org/c/qt/qtbase/+/404056 adds a few constructors to QDate. The documentation says

          \fn QDate::QDate(std::chrono::year_month_day ymd)
      

      but the generated docs https://doc-snapshots.qt.io/qt6-dev/qdate.html#QDate-4 say

      [since 6.4]
      template <typename> QDate::QDate(int ymd)
      

      I suspect the template part is picked up by expanding QT_POST_CXX17_API_IN_EXPORTED_CLASS, which however should be ignored by qdoc? See https://codereview.qt-project.org/c/qt/qtbase/+/404961

      But anyways, where does that int argument come from?

      The same applies to many other methods, for instance

      https://doc-snapshots.qt.io/qt6-dev/qdate.html#fromStdSysDays
      https://doc-snapshots.qt.io/qt6-dev/qdatetime.html#fromStdLocalTime
      https://doc-snapshots.qt.io/qt6-dev/qdatetime.html#fromStdTimePoint-1
      https://doc-snapshots.qt.io/qt6-dev/qdatetime.html#fromStdZonedTime
      https://doc-snapshots.qt.io/qt6-dev/qdatetime.html#toStdSysMilliseconds

      and so on.

        Attachments

          Issue Links

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

            Activity

              People

              Assignee:
              docinfrastructure Documentation Infrastructure Team
              Reporter:
              peppe Giuseppe D'Angelo
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Gerrit Reviews

                  There are no open Gerrit changes