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

QDoc: Implement COMMAND_COMPARISON

    XMLWordPrintable

Details

    • Task
    • Resolution: Fixed
    • P2: Important
    • 6.7.0 FF
    • None
    • Build tools: qdoc
    • None
    • 3d3970d75 (dev)
    • DaVinci89, DaVinci 90, DaVinci 91

    Description

      This is an implementation task resulted from QTBUG-104110.

      In summary;

      Introduce a new command, `\comparison`, to QDoc. The command shall take one argument that represents the comparison category of the type being documented. This argument shall be one of the following:

        `strong`
        `partial`
        `weak`
        `equality`

      QDoc shall generate a statement as part of the type's documentation, immediately preceding the admonition about thread safety, e.g:

          `This type is strongly comparable with itself.`

      Attachments

        Issue Links

          is blocked by

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-118558 QDoc: DocParser::getRestOfLine no longer strips trailing backslashes and whitespace properly

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed
          is required for

          Task - A task that needs to be done. QTBUG-117913 QDoc: Implement COMMAND_COMPARES

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed
          resulted from

          User Story - Created by Jira Software - do not edit or delete. Issue type for a user story. QTBUG-104110 Support easy, yet precise, documenting of relational operators

          • P1: Critical - Urgent and Important, will STOP the release if matched with set FixVersion field. This includes regressions from the last version that are not edge cases; Data loss; Build issues; All but the most unlikely crashes/lockups/hanging; Serious usability issues and embarrassing bugs & Bugs critical to a deliverable. This is the highest possible priority for requirements.
          • Closed
          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              treinio Topi Reiniö
              paulwicking Paul Wicking
              Tino Pyssysalo Tino Pyssysalo
              Topi Reiniö Topi Reiniö
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes