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

QAnimationDriver::advanceAnimation documentation is wrong

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Reported
    • Priority: P3: Somewhat important
    • Resolution: Unresolved
    • Affects Version/s: 5.9.4, 5.10, 5.11, 5.12.0, 5.13.0, 5.14.0
    • Fix Version/s: None
    • Labels:
      None

      Description

      The documentation of QAnimationDriver::advanceAnimation currently claims:
      "Since 5.4, the timeStep argument is ignored and elapsed() will be
      used instead in combination with the internal time offsets of the
      animation system."

      That sentence was added by Gunnar before 5,4 in dfc8f8b5d4a02f33c7f9063c2a28450902a9d863, and that time QUnifiedTimer::updateAnimationTimers(qint64) did indeed ignore the currentTick argument.

      In 5.9.4, with commit 0c9e379dd8c57fab9d8e6ba8d35a0dca8ac05a0a by Jan Arve, this was changed and updateAnimationTimers() does uses the currentTick argument. This makes the documentation wrong.

      There's a related comment "// ### Qt6: Remove timestep argument" on the QAnimationDriver::advanceAnimation() declaration, which appears to be outdated too.

      I have actually no clue about the class and how it should work, but this appears to me to be a clear difference between what the documentation claims and what the actual code does.

        Attachments

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

          Activity

            People

            Assignee:
            docteam Qt Documentation Team
            Reporter:
            dt Daniel Teske
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:

                Gerrit Reviews

                There are no open Gerrit changes