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

Wrong hyperlinks in class references: QAudioInput/QAudioOutput

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done
    • P2: Important
    • 5.0.1
    • 5.0.0 Beta 1
    • Documentation, Multimedia
    • None
    • 52ad3219f073b87cfc1c57ced77266e3e7fad7ee (qt5/qtmultimedia)

    Description

      http://qt-project.org/doc/qt-5.0/qaudioinput.html#details
      http://qt-project.org/doc/qt-5.0/qaudiooutput.html#details

      Issue
      Clicking on AudioInputExample::stateChanged() [slot] jumps to QAudioInput::stateChanged() [signal]. Similar for QAudioOutput.

      Probable cause
      The example slots, introduced in Qt 5.0 docs, share the same name as class signals (e.g. AudioInputExample::stateChanged() vs. QAudioInput::stateChanged())

      Suggestion
      Change the slot names (e.g. to handleStateChange()), for multiple reasons:

      1. Remove wrong hyperlink
      2. Prevent reader confusion – remove ambiguity from "stateChanged()"
      3. Follow existing signal/slot naming conventions – signal names tend to be "reports" in past tense (e.g. QSlider::valueChanged()), whilst slot names tend to be "actions" in present tense (QSlider::setValue()).

      Attachments

        For Gerrit Dashboard: QTBUG-26688
        # Subject Branch Project Status CR V

        Activity

          People

            treinio Topi Reiniƶ
            jksh Sze Howe Koh
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes