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

qdoc: Detect and warn if snippet markers are more indented than snippet contents

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • P2: Important
    • None
    • None
    • Build tools: qdoc
    • None

    Description

      QTBUG-138492 was caused by the following phenomenon.

      This source code:

          //! [0]
      int MyClass::myFunc()
      {
          return 42;
      }
          //! [0]
      

       

      ...would get rendered in the qdoc output like this:

      int MyClass::myFunc()
      {
      return 42;
      }
      

       

      Suggestion
      Detect and warn of such cases, because the //! markers need to reduce their indentation levels.

      Attachments

        Issue Links

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

          Activity

            People

              docinfrastructure Documentation Infrastructure Team
              skoh-qt Sze Howe Koh
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes