diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-01 15:28:31 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-02 23:16:25 +0100 |
commit | 95d83cb1b68cc4a415d5d80859b4e74472ad7112 (patch) | |
tree | 9f6fa892ee78f584224320a195f03419c0fdbc21 /doc/src/corelib/objectmodel | |
parent | 15e136d4e116c1513c106dfbb75e1953a7f3463c (diff) |
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold
and list items. This change applies that change in QDoc to the
actual documentation.
Task-number: QTBUG-24578
Change-Id: I519bf9c29b14092e3ab6067612f42bf749eeedf5
Reviewed-by: Shane Kearns <shane.kearns@accenture.com>
Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
Diffstat (limited to 'doc/src/corelib/objectmodel')
-rw-r--r-- | doc/src/corelib/objectmodel/metaobjects.qdoc | 18 | ||||
-rw-r--r-- | doc/src/corelib/objectmodel/object.qdoc | 26 | ||||
-rw-r--r-- | doc/src/corelib/objectmodel/properties.qdoc | 22 |
3 files changed, 33 insertions, 33 deletions
diff --git a/doc/src/corelib/objectmodel/metaobjects.qdoc b/doc/src/corelib/objectmodel/metaobjects.qdoc index 7edb376e25..c92f6f2f09 100644 --- a/doc/src/corelib/objectmodel/metaobjects.qdoc +++ b/doc/src/corelib/objectmodel/metaobjects.qdoc @@ -41,12 +41,12 @@ The meta-object system is based on three things: \list 1 - \o The \l QObject class provides a base class for objects that can + \li The \l QObject class provides a base class for objects that can take advantage of the meta-object system. - \o The Q_OBJECT macro inside the private section of the class + \li The Q_OBJECT macro inside the private section of the class declaration is used to enable meta-object features, such as dynamic properties, signals, and slots. - \o The \l{moc}{Meta-Object Compiler} (\c moc) supplies each + \li The \l{moc}{Meta-Object Compiler} (\c moc) supplies each QObject subclass with the necessary code to implement meta-object features. \endlist @@ -64,19 +64,19 @@ additional features: \list - \o QObject::metaObject() returns the associated + \li QObject::metaObject() returns the associated \l{QMetaObject}{meta-object} for the class. - \o QMetaObject::className() returns the class name as a + \li QMetaObject::className() returns the class name as a string at run-time, without requiring native run-time type information (RTTI) support through the C++ compiler. - \o QObject::inherits() function returns whether an object is an + \li QObject::inherits() function returns whether an object is an instance of a class that inherits a specified class within the QObject inheritance tree. - \o QObject::tr() and QObject::trUtf8() translate strings for + \li QObject::tr() and QObject::trUtf8() translate strings for \l{Internationalization with Qt}{internationalization}. - \o QObject::setProperty() and QObject::property() + \li QObject::setProperty() and QObject::property() dynamically set and get properties by name. - \o QMetaObject::newInstance() constructs a new instance of the class. + \li QMetaObject::newInstance() constructs a new instance of the class. \endlist \target qobjectcast diff --git a/doc/src/corelib/objectmodel/object.qdoc b/doc/src/corelib/objectmodel/object.qdoc index cf3ce4ef31..4e212b37dd 100644 --- a/doc/src/corelib/objectmodel/object.qdoc +++ b/doc/src/corelib/objectmodel/object.qdoc @@ -41,20 +41,20 @@ Qt adds these features to C++: \list - \o a very powerful mechanism for seamless object + \li a very powerful mechanism for seamless object communication called \l{signals and slots} - \o queryable and designable \l{Qt's Property System}{object + \li queryable and designable \l{Qt's Property System}{object properties} - \o powerful \l{The Event System}{events and event filters} - \o contextual \l{i18n}{string translation for internationalization} - \o sophisticated interval driven \l timers that make it possible + \li powerful \l{The Event System}{events and event filters} + \li contextual \l{i18n}{string translation for internationalization} + \li sophisticated interval driven \l timers that make it possible to elegantly integrate many tasks in an event-driven GUI - \o hierarchical and queryable \l{Object Trees & Ownership}{object + \li hierarchical and queryable \l{Object Trees & Ownership}{object trees} that organize object ownership in a natural way - \o guarded pointers (QPointer) that are automatically + \li guarded pointers (QPointer) that are automatically set to 0 when the referenced object is destroyed, unlike normal C++ pointers which become dangling pointers when their objects are destroyed - \o a \l{metaobjects.html#qobjectcast}{dynamic cast} that works across + \li a \l{metaobjects.html#qobjectcast}{dynamic cast} that works across library boundaries. \endlist @@ -92,22 +92,22 @@ or assigning a value. We can see what this means in the Qt Object Model. - \bold{A Qt Object...} + \b{A Qt Object...} \list - \o might have a unique \l{QObject::objectName()}. If we copy a Qt + \li might have a unique \l{QObject::objectName()}. If we copy a Qt Object, what name should we give the copy? - \o has a location in an \l{Object Trees & Ownership} + \li has a location in an \l{Object Trees & Ownership} {object hierarchy}. If we copy a Qt Object, where should the copy be located? - \o can be connected to other Qt Objects to emit signals to them or + \li can be connected to other Qt Objects to emit signals to them or to receive signals emitted by them. If we copy a Qt Object, how should we transfer these connections to the copy? - \o can have \l{Qt's Property System} {new properties} added to it + \li can have \l{Qt's Property System} {new properties} added to it at runtime that are not declared in the C++ class. If we copy a Qt Object, should the copy include the properties that were added to the original? diff --git a/doc/src/corelib/objectmodel/properties.qdoc b/doc/src/corelib/objectmodel/properties.qdoc index 894efd017d..4d090af8fc 100644 --- a/doc/src/corelib/objectmodel/properties.qdoc +++ b/doc/src/corelib/objectmodel/properties.qdoc @@ -58,20 +58,20 @@ \list - \o A \c READ accessor function is required. It is for reading the + \li A \c READ accessor function is required. It is for reading the property value. Ideally, a const function is used for this purpose, and it must return either the property's type or a pointer or reference to that type. e.g., QWidget::focus is a read-only property with \c READ function, QWidget::hasFocus(). - \o A \c WRITE accessor function is optional. It is for setting the + \li A \c WRITE accessor function is optional. It is for setting the property value. It must return void and must take exactly one argument, either of the property's type or a pointer or reference to that type. e.g., QWidget::enabled has the \c WRITE function QWidget::setEnabled(). Read-only properties do not need \c WRITE functions. e.g., QWidget::focus has no \c WRITE function. - \o A \c RESET function is optional. It is for setting the property + \li A \c RESET function is optional. It is for setting the property back to its context specific default value. e.g., QWidget::cursor has the typical \c READ and \c WRITE functions, QWidget::cursor() and QWidget::setCursor(), and it also has a \c RESET function, @@ -79,26 +79,26 @@ mean \e {reset to the context specific cursor}. The \c RESET function must return void and take no parameters. - \o A \c NOTIFY signal is optional. If defined, it should specify one + \li A \c NOTIFY signal is optional. If defined, it should specify one existing signal in that class that is emitted whenever the value of the property changes. - \o A \c REVISION number is optional. If included, it defines the + \li A \c REVISION number is optional. If included, it defines the the property and its notifier signal to be used in a particular revision of the API that is exposed to QML. - \o The \c DESIGNABLE attribute indicates whether the property + \li The \c DESIGNABLE attribute indicates whether the property should be visible in the property editor of GUI design tool (e.g., \l {Qt Designer}). Most properties are \c DESIGNABLE (default true). Instead of true or false, you can specify a boolean member function. - \o The \c SCRIPTABLE attribute indicates whether this property + \li The \c SCRIPTABLE attribute indicates whether this property should be accessible by a scripting engine (default true). Instead of true or false, you can specify a boolean member function. - \o The \c STORED attribute indicates whether the property should + \li The \c STORED attribute indicates whether the property should be thought of as existing on its own or as depending on other values. It also indicates whether the property value must be saved when storing the object's state. Most properties are \c STORED @@ -106,20 +106,20 @@ false, because its value is just taken from the width component of property QWidget::minimumSize(), which is a QSize. - \o The \c USER attribute indicates whether the property is + \li The \c USER attribute indicates whether the property is designated as the user-facing or user-editable property for the class. Normally, there is only one \c USER property per class (default false). e.g., QAbstractButton::checked is the user editable property for (checkable) buttons. Note that QItemDelegate gets and sets a widget's \c USER property. - \o The presence of the \c CONSTANT attibute indicates that the property + \li The presence of the \c CONSTANT attibute indicates that the property value is constant. For a given object instance, the READ method of a constant property must return the same value every time it is called. This constant value may be different for different instances of the object. A constant property cannot have a WRITE method or a NOTIFY signal. - \o The presence of the \c FINAL attribute indicates that the property + \li The presence of the \c FINAL attribute indicates that the property will not be overridden by a derived class. This can be used for performance optimizations in some cases, but is not enforced by moc. Care must be taken never to override a \c FINAL property. |