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

qdoc: unnamed first argument shifts remaining arguments

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: P2: Important P2: Important
    • 6.1.0 RC
    • 6.0.0 Beta1
    • Build tools: qdoc
    • None
    • 8
    • 58bca83555914cacf124acf0a687312bb547b85c (qt/qttools/dev)
    • Da Vinci sprint 19, Da Vinci sprint 20

      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.

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

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

              Created:
              Updated:
              Resolved:

                There are no open Gerrit changes