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

qdoc: Warn if a \deprecated string does not end with a dot.

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • P3: Somewhat important
    • None
    • None
    • Build tools: qdoc
    • None
    • e54971170 (dev), e5912919a (6.6), 25575b905 (6.5), f2e622a75 (dev)
    • DaVinci 88

    Description

      qdoc could warn if the string passed to \deprecated doesn't end with a dot, as this will lead to incorrect grammar in the generated documentation.

      E.g.

      /*!
    \deprecated [6.9] Use setTimeZone() instead
   [...]
*/
void QDateTime::setTimeSpec(Qt::TimeSpec spec)

      generates

      void QDateTime::setTimeSpec(Qt::TimeSpec spec)

This function is deprecated since 6.9. We strongly advise against using it in new code.

Use setTimeZone() instead

      The last sentence looks out of place, as it doesn't end with a end-of-sentence marker. Anyhow, that is not obvious in qdoc.

      Attachments

        Issue Links

          is blocked by

          Suggestion - Public suggestions QTBUG-114157 qdoc: Consolidate and emphasize \deprecated messages for QML and C++

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

          Suggestion - Public suggestions QTBUG-117636 QDoc: Add full stops to briefs without proper punctuation

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Open
          For Gerrit Dashboard: QTBUG-117470
          # Subject Branch Project Status CR V
          507265,10 WIP: QDoc: Insert missing full stop for briefs dev qt/qttools Status: NEW -2 0

          Activity

            People

              docinfrastructure Documentation Infrastructure Team
              kkohne Kai Köhne
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There is 1 open Gerrit change