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

qdoc: Obsolete/deprecated methods not marked as such in the WebXML output

    XMLWordPrintable

Details

    • Bug
    • Resolution: Incomplete
    • P2: Important
    • None
    • 5.12
    • Build tools: qdoc
    • None

    Description

      When using qdoc to generate the documentation as WebXML, I noticed that many functions should be marked as obsolete/deprecated, but are not in WebXML.

      For instance, in QAbstractEventDispatcher, this is the content of the WebXML file (status="active") for filterEvent:

      <function threadsafety="unspecified" name="filterEvent" fullname="QAbstractEventDispatcher::filterEvent" href="qabstracteventdispatcher.html#filterEvent" status="active" access="public" location="qabstracteventdispatcher.h" filepath="C:/Qt/5.11.1/Src/qtbase/src/corelib/kernel/qabstracteventdispatcher.h" lineno="115" virtual="non" meta="plain" const="false" static="false" overload="false" delete="false" default="false" final="false" override="false" type="bool" signature="bool filterEvent(void *message)">
       <parameter type="void *" name="message" default=""/>
       <description path="" line="0" column="0"/>
       </function>
      

      However, this method should not be active. Indeed, it is not shown in http://doc.qt.io/qt-5/qxmlnodemodelindex.html (but it is in the obsolete methods http://doc.qt.io/qt-5/qabstracteventdispatcher-obsolete.html#filterEvent and in Qt 4.8's documentation http://doc.qt.io/archives/qt-4.8/qabstracteventdispatcher.html#filterEvent). Moreover, the CPP source clearly indicates \deprecated (https://github.com/qt/qtbase/blob/c5307203f5c0b0e588cc93e70764c090dd4c2ce0/src/corelib/kernel/qabstracteventdispatcher.cpp#L473). However, the method is not present in PySide's documentation.

      The same happens with QWheelEvent::orientation (https://github.com/elProxy/qtbase/blob/4933c8077d99c1b84117d7e5ece7daf13867bc70/src/gui/kernel/qevent.cpp#L573).

      I generated the WebXML source based on Qt 5.11.1 sources, using qdoc from Qt 5.12.0. All of these were installed with the standard maintenance tool for Windows ("Qt Online Installer for Windows").

      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
              dourouc05_ Thibaut Cuvelier
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes