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

qdoc: unnamed first argument shifts remaining arguments

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: P2: Important
    • Resolution: Done
    • Affects Version/s: 6.0.0 Beta1
    • Fix Version/s: None
    • Component/s: Build tools: qdoc
    • Labels:
      None
    • Commits:
      58bca83555914cacf124acf0a687312bb547b85c (qt/qttools/dev)
    • Story Points:
      8
    • Sprint:
      Da Vinci sprint 19, Da Vinci sprint 20

      Description

      QPointer has an operator== overload for std::nullptr_t (a hidden friend, hence the somewhat weird prototype, but that seems irrelevant):

      /*!
          \fn template <typename T> bool QPointer<T>::operator!=(std::nullptr_t, const QPointer<T> &rhs)
      ...
      

      In the generated documentation, the function is documented as:

      bool operator==(std::nullptr_t rhs, const QPointer<T> &)
      

      Naming the first argument (e.g. "lhs") is a workaround, but then one has to document it as well to avoid qdoc warnings, whereas saying that "returns true when \a rhs is \nullptr" says everything there is to be said.

        Attachments

          Issue Links

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

            Activity

              People

              Assignee:
              treinio Topi Reiniƶ
              Reporter:
              vhilshei Volker Hilsheimer
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Gerrit Reviews

                  There are no open Gerrit changes