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

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

XMLWordPrintable

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

      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.

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

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

              Created:
              Updated:

                There is 1 open Gerrit change