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

qdoc should ignore internal properties, functions, signals & handlers

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done
    • P1: Critical
    • 5.0.2
    • 5.0.1
    • Documentation
    • None
    • 02e451ca5713543c65f023e9ee5b4e69774f664b, e9cc6727d546201cfd5a41dde6626f04143ce683

    Description

      import QtQuick 2.0
      
      /*!
          \qmltype FancyControl
          \inqmlmodule QtQuick.Controls 1.0
          \brief A fancy QML control for qdoc demonstration purposes.
      
          Foo bar....
      */
      
      Item {
          /*! Should appear in the docs. */
          signal publicSignal
      
          /*! Should appear in the docs. */
          function publicFunction() { }
      
          /*! Should appear in the docs. */
          property Component publicProperty: Item {
      
              // Should NOT appear in the docs, because the user
              // of FancyControl cannot access 'internalProperty'
              property var internalProperty
      
              // Should NOT appear in the docs, because the user of
              // FancyControl cannot see or react to 'internalSignal'
              signal internalSignal
      
              // Should NOT appear in the docs, because the user
              // of FancyControl cannot call 'internalFunction'
              function internalFunction() { }
      
              // Should NOT appear in the docs...
              onInternalPropertyChanged: { }
      
              // Should NOT appear in the docs...
              onInternalSignal:  { }
          }
      
          // Should NOT appear in the docs, we document 'publicProperty' instead.
          // It is an implementation detail if we are listening to the property
          // changes inside FancyControl. The user can write his/her own signal
          // handler, but he/she cannot access our signal handler.
          onPublicPropertyChanged: { }
      
          // Should NOT appear in the docs, we document 'publicSignal' instead.
          // It is an implementation detail if we are listening to the signal
          // inside FancyControl. The user can write his/her own signal handler,
          // but he/she cannot access our signal handler.
          onPublicSignal: { }
      }
      

      Attachments

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

        Activity

          People

            gbk Martin Smith (Qt)
            jpnurmi J-P Nurmi
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes