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

Generated documentation for change signals that represent more than one property is hard to read

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Reported
    • Priority: P3: Somewhat important
    • Resolution: Unresolved
    • Affects Version/s: 5.15
    • Fix Version/s: None
    • Component/s: Build tools: qdoc
    • Labels:
      None

      Description

      https://doc.qt.io/qt-5/qaction.html#changed says:

      Note: Notifier signal for property autoRepeat. Notifier signal for property checkable. Notifier signal for property enabled. Notifier signal for property font. Notifier signal for property icon. Notifier signal for property iconText. Notifier signal for property iconVisibleInMenu. Notifier signal for property menuRole. Notifier signal for property shortcut. Notifier signal for property shortcutContext. Notifier signal for property shortcutVisibleInContextMenu. Notifier signal for property statusTip. Notifier signal for property text. Notifier signal for property toolTip. Notifier signal for property visible. Notifier signal for property whatsThis.

      This is very verbose and repetitive, making it difficult to read.

      I'm assuming it is generated, because I don't see it anywhere in qaction.cpp.

      It would be easier to read if it was e.g.:

      Note: this is the notifier signal for the following properties: autoRepeat, checkable, [...]

        Attachments

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

          Activity

            People

            Assignee:
            docinfrastructure Documentation Infrastructure Team
            Reporter:
            mitch_curtis Mitch Curtis
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:

                Gerrit Reviews

                There are no open Gerrit changes