diff options
author | Laszlo Papp <lpapp@kde.org> | 2012-08-15 06:37:01 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-08-15 11:38:37 +0200 |
commit | 98804946f289fe8ab866cc7bf3383a29057f9251 (patch) | |
tree | ada01afead223ec58579061ef3bb13771782149e /src/corelib/kernel | |
parent | 121062d8848986dcfaf421388a5603b3b48a1e58 (diff) |
Make the "\internal" qdoc command stand on its own line
The qdoc manual currently claims that the command must stand on its own line.
The change follows the consistency with the rest and how the example looks like
inside the qdoc manual for this command.
Change-Id: I6b653dc95cf9d84e4adf32220dace5d313678419
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
Diffstat (limited to 'src/corelib/kernel')
-rw-r--r-- | src/corelib/kernel/qabstracteventdispatcher.cpp | 8 | ||||
-rw-r--r-- | src/corelib/kernel/qcoreapplication.cpp | 6 | ||||
-rw-r--r-- | src/corelib/kernel/qcoreevent.cpp | 10 | ||||
-rw-r--r-- | src/corelib/kernel/qmetaobject.cpp | 19 | ||||
-rw-r--r-- | src/corelib/kernel/qmetatype.cpp | 27 | ||||
-rw-r--r-- | src/corelib/kernel/qobject.cpp | 81 | ||||
-rw-r--r-- | src/corelib/kernel/qvariant.cpp | 13 |
7 files changed, 111 insertions, 53 deletions
diff --git a/src/corelib/kernel/qabstracteventdispatcher.cpp b/src/corelib/kernel/qabstracteventdispatcher.cpp index d17d1c6335..b018f545be 100644 --- a/src/corelib/kernel/qabstracteventdispatcher.cpp +++ b/src/corelib/kernel/qabstracteventdispatcher.cpp @@ -329,11 +329,15 @@ int QAbstractEventDispatcher::registerTimer(int interval, Qt::TimerType timerTyp // ### DOC: Are these called when the _application_ starts/stops or just // when the current _event loop_ starts/stops? -/*! \internal */ +/*! + \internal +*/ void QAbstractEventDispatcher::startingUp() { } -/*! \internal */ +/*! + \internal +*/ void QAbstractEventDispatcher::closingDown() { } diff --git a/src/corelib/kernel/qcoreapplication.cpp b/src/corelib/kernel/qcoreapplication.cpp index d3fb7f4018..8d071e0ba2 100644 --- a/src/corelib/kernel/qcoreapplication.cpp +++ b/src/corelib/kernel/qcoreapplication.cpp @@ -515,7 +515,8 @@ void QCoreApplicationPrivate::initLocale() If no instance has been allocated, \c null is returned. */ -/*!\internal +/*! + \internal */ QCoreApplication::QCoreApplication(QCoreApplicationPrivate &p) : QObject(p, 0) @@ -821,7 +822,8 @@ bool QCoreApplicationPrivate::sendThroughObjectEventFilters(QObject *receiver, Q return false; } -/*!\internal +/*! + \internal Helper function called by notify() */ diff --git a/src/corelib/kernel/qcoreevent.cpp b/src/corelib/kernel/qcoreevent.cpp index 421796249b..c542f825a3 100644 --- a/src/corelib/kernel/qcoreevent.cpp +++ b/src/corelib/kernel/qcoreevent.cpp @@ -450,7 +450,8 @@ QTimerEvent::QTimerEvent(int timerId) : QEvent(Timer), id(timerId) {} -/*! \internal +/*! + \internal */ QTimerEvent::~QTimerEvent() { @@ -495,7 +496,8 @@ QChildEvent::QChildEvent(Type type, QObject *child) : QEvent(type), c(child) {} -/*! \internal +/*! + \internal */ QChildEvent::~QChildEvent() { @@ -574,7 +576,9 @@ QDeferredDeleteEvent::QDeferredDeleteEvent() , level(0) { } -/*! \internal */ +/*! + \internal +*/ QDeferredDeleteEvent::~QDeferredDeleteEvent() { } diff --git a/src/corelib/kernel/qmetaobject.cpp b/src/corelib/kernel/qmetaobject.cpp index 90cebe2291..14ca6e1b3e 100644 --- a/src/corelib/kernel/qmetaobject.cpp +++ b/src/corelib/kernel/qmetaobject.cpp @@ -574,7 +574,8 @@ static bool methodMatch(const QMetaObject *m, int handle, return true; } -/** \internal +/** +* \internal * helper function for indexOf{Method,Slot,Signal}, returns the relative index of the method within * the baseObject * \a MethodType might be MethodSignal or MethodSlot, or 0 to match everything. @@ -705,7 +706,8 @@ int QMetaObject::indexOfSignal(const char *signal) const return i; } -/*! \internal +/*! + \internal Same as QMetaObject::indexOfSignal, but the result is the local offset to the base object. \a baseObject will be adjusted to the enclosing QMetaObject, or 0 if the signal is not found @@ -851,7 +853,8 @@ int QMetaObjectPrivate::signalIndex(const QMetaMethod &m) return ((m.handle - priv(m.mobj->d.data)->methodData) / 5) + signalOffset(m.mobj); } -/*! \internal +/*! + \internal \since 5.0 Returns the signal for the given meta-object \a m at \a signal_index. @@ -1861,7 +1864,9 @@ const char *QMetaMethod::tag() const } -/*! \internal */ +/*! + \internal + */ int QMetaMethod::attributes() const { if (!mobj) @@ -1940,7 +1945,8 @@ QMetaMethod::MethodType QMetaMethod::methodType() const \snippet code/src_corelib_kernel_qmetaobject.cpp 9 */ -/*! \internal +/*! + \internal Implementation of the fromSignal() function. @@ -3275,7 +3281,8 @@ const char* QMetaClassInfo::value() const and \a data. */ -/*! \internal +/*! + \internal If the local_method_index is a cloned method, return the index of the original. Example: if the index of "destroyed()" is passed, the index of "destroyed(QObject*)" is returned diff --git a/src/corelib/kernel/qmetatype.cpp b/src/corelib/kernel/qmetatype.cpp index 29179db45d..18b17d9aea 100644 --- a/src/corelib/kernel/qmetatype.cpp +++ b/src/corelib/kernel/qmetatype.cpp @@ -314,7 +314,8 @@ Q_GLOBAL_STATIC(QVector<QCustomTypeInfo>, customTypes) Q_GLOBAL_STATIC(QReadWriteLock, customTypesLock) #ifndef QT_NO_DATASTREAM -/*! \internal +/*! + \internal */ void QMetaType::registerStreamOperators(const char *typeName, SaveOperator saveOp, LoadOperator loadOp) @@ -322,7 +323,8 @@ void QMetaType::registerStreamOperators(const char *typeName, SaveOperator saveO registerStreamOperators(type(typeName), saveOp, loadOp); } -/*! \internal +/*! + \internal */ void QMetaType::registerStreamOperators(int idx, SaveOperator saveOp, LoadOperator loadOp) @@ -382,7 +384,8 @@ const char *QMetaType::typeName(int typeId) return result; } -/*! \internal +/*! + \internal Similar to QMetaType::type(), but only looks in the static set of types. */ static inline int qMetaTypeStaticType(const char *typeName, int length) @@ -395,7 +398,8 @@ static inline int qMetaTypeStaticType(const char *typeName, int length) return types[i].type; } -/*! \internal +/*! + \internal Similar to QMetaType::type(), but only looks in the custom set of types, and doesn't lock the mutex. */ @@ -417,7 +421,8 @@ static int qMetaTypeCustomType_unlocked(const char *typeName, int length) return QMetaType::UnknownType; } -/*! \internal +/*! + \internal This function is needed until existing code outside of qtbase has been changed to call the new version of registerType(). @@ -428,7 +433,8 @@ int QMetaType::registerType(const char *typeName, Deleter deleter, return registerType(typeName, deleter, creator, qMetaTypeDestructHelper<void>, qMetaTypeConstructHelper<void>, 0, TypeFlags(), 0); } -/*! \internal +/*! + \internal \since 5.0 Registers a user type for marshalling, with \a typeName, a \a @@ -452,7 +458,8 @@ int QMetaType::registerType(const char *typeName, Deleter deleter, } -/*! \internal +/*! + \internal \since 5.0 Registers a user type for marshalling, with \a normalizedTypeName, a \a @@ -528,7 +535,8 @@ int QMetaType::registerNormalizedType(const NS(QByteArray) &normalizedTypeName, return idx; } -/*! \internal +/*! + \internal \since 4.7 Registers a user type for marshalling, as an alias of another type (typedef) @@ -544,7 +552,8 @@ int QMetaType::registerTypedef(const char* typeName, int aliasId) return registerNormalizedTypedef(normalizedTypeName, aliasId); } -/*! \internal +/*! + \internal \since 5.0 Registers a user type for marshalling, as an alias of another type (typedef). diff --git a/src/corelib/kernel/qobject.cpp b/src/corelib/kernel/qobject.cpp index cf573ac534..a00d528ec9 100644 --- a/src/corelib/kernel/qobject.cpp +++ b/src/corelib/kernel/qobject.cpp @@ -122,7 +122,8 @@ static int *queuedConnectionTypes(const QArgumentType *argumentTypes, int argc) static QBasicMutex _q_ObjectMutexPool[131]; -/** \internal +/** + * \internal * mutex to be locked when accessing the connectionlists or the senders list */ static inline QMutex *signalSlotLock(const QObject *o) @@ -232,7 +233,8 @@ QObjectPrivate::~QObjectPrivate() delete extraData; } -/*!\internal +/*! + \internal For a given metaobject, compute the signal offset, and the method offset (including signals) */ static void computeOffsets(const QMetaObject *metaobject, int *signalOffset, int *methodOffset) @@ -339,7 +341,8 @@ QObjectList QObjectPrivate::senderList() const return returnValue; } -/*! \internal +/*! + \internal Add the connection \a c to to the list of connections of the sender's object for the specified \a signal @@ -415,7 +418,8 @@ void QObjectPrivate::cleanConnectionLists() } } -/*! \internal +/*! + \internal */ QMetaCallEvent::QMetaCallEvent(ushort method_offset, ushort method_relative, QObjectPrivate::StaticMetaCallFunction callFunction, const QObject *sender, int signalId, @@ -425,7 +429,8 @@ QMetaCallEvent::QMetaCallEvent(ushort method_offset, ushort method_relative, QOb callFunction_(callFunction), method_offset_(method_offset), method_relative_(method_relative) { } -/*! \internal +/*! + \internal */ QMetaCallEvent::QMetaCallEvent(QObject::QSlotObjectBase *slotO, const QObject *sender, int signalId, int nargs, int *types, void **args, QSemaphore *semaphore) @@ -437,7 +442,8 @@ QMetaCallEvent::QMetaCallEvent(QObject::QSlotObjectBase *slotO, const QObject *s slotObj_->ref.ref(); } -/*! \internal +/*! + \internal */ QMetaCallEvent::~QMetaCallEvent() { @@ -457,7 +463,8 @@ QMetaCallEvent::~QMetaCallEvent() delete slotObj_; } -/*! \internal +/*! + \internal */ void QMetaCallEvent::placeMetaCall(QObject *object) { @@ -679,7 +686,8 @@ QObject::QObject(QObject *parent) qt_addObject(this); } -/*! \internal +/*! + \internal */ QObject::QObject(QObjectPrivate &dd, QObject *parent) : d_ptr(&dd) @@ -1692,7 +1700,8 @@ void qt_qFindChildren_helper(const QObject *parent, const QRegularExpression &re } #endif // QT_NO_REGEXP -/*! \internal +/*! + \internal */ QObject *qt_qFindChild_helper(const QObject *parent, const QString &name, const QMetaObject &mo, Qt::FindChildOptions options) { @@ -2940,7 +2949,8 @@ void QObject::disconnectNotify(const QMetaMethod &signal) Q_UNUSED(signal); } -/* \internal +/* + \internal convert a signal index from the method range to the signal range */ static int methodIndexToSignalIndex(const QMetaObject **base, int signal_index) @@ -2963,7 +2973,8 @@ static int methodIndexToSignalIndex(const QMetaObject **base, int signal_index) return signal_index; } -/*!\internal +/*! + \internal \a types is a 0-terminated vector of meta types for queued connections. @@ -2981,7 +2992,8 @@ QMetaObject::Connection QMetaObject::connect(const QObject *sender, int signal_i type, types)); } -/*! \internal +/*! + \internal Same as the QMetaObject::connect, but \a signal_index must be the result of QObjectPrivate::signalIndex method_index is relative to the rmeta metaobject, if rmeta is null, then it is absolute index @@ -3043,7 +3055,8 @@ QObjectPrivate::Connection *QMetaObjectPrivate::connect(const QObject *sender, return c.take(); } -/*!\internal +/*! + \internal */ bool QMetaObject::disconnect(const QObject *sender, int signal_index, const QObject *receiver, int method_index) @@ -3054,7 +3067,8 @@ bool QMetaObject::disconnect(const QObject *sender, int signal_index, receiver, method_index, 0); } -/*!\internal +/*! + \internal Disconnect a single signal connection. If QMetaObject::connect() has been called multiple times for the same sender, signal_index, receiver and method_index only @@ -3070,7 +3084,8 @@ bool QMetaObject::disconnectOne(const QObject *sender, int signal_index, QMetaObjectPrivate::DisconnectOne); } -/*! \internal +/*! + \internal Helper function to remove the connection from the senders list and setting the receivers to 0 */ bool QMetaObjectPrivate::disconnectHelper(QObjectPrivate::Connection *c, @@ -3111,7 +3126,8 @@ bool QMetaObjectPrivate::disconnectHelper(QObjectPrivate::Connection *c, return success; } -/*! \internal +/*! + \internal Same as the QMetaObject::disconnect, but \a signal_index must be the result of QObjectPrivate::signalIndex */ bool QMetaObjectPrivate::disconnect(const QObject *sender, @@ -3238,7 +3254,8 @@ void QMetaObject::connectSlotsByName(QObject *o) } } -/*! \internal +/*! + \internal \a signal must be in the signal index range (see QObjectPrivate::signalIndex()). */ @@ -3275,7 +3292,8 @@ static void queued_activate(QObject *sender, int signal, QObjectPrivate::Connect QCoreApplication::postEvent(c->receiver, ev); } -/*!\internal +/*! + \internal */ void QMetaObject::activate(QObject *sender, const QMetaObject *m, int local_signal_index, void **argv) @@ -3283,7 +3301,8 @@ void QMetaObject::activate(QObject *sender, const QMetaObject *m, int local_sign activate(sender, QMetaObjectPrivate::signalOffset(m), local_signal_index, argv); } -/*!\internal +/*! + \internal */ void QMetaObject::activate(QObject *sender, int signalOffset, int local_signal_index, void **argv) { @@ -3443,7 +3462,8 @@ void QMetaObject::activate(QObject *sender, int signalOffset, int local_signal_i } -/*!\internal +/*! + \internal signal_index comes from indexOfMethod() */ void QMetaObject::activate(QObject *sender, int signal_index, void **argv) @@ -3454,7 +3474,8 @@ void QMetaObject::activate(QObject *sender, int signal_index, void **argv) activate(sender, mo, signal_index - mo->methodOffset(), argv); } -/*! \internal +/*! + \internal Implementation of QObject::senderSignalIndex() */ int QObjectPrivate::senderSignalIndex() const @@ -3472,7 +3493,8 @@ int QObjectPrivate::senderSignalIndex() const return -1; } -/*! \internal +/*! + \internal Returns the signal index used in the internal connectionLists vector. It is different from QMetaObject::indexOfSignal(): indexOfSignal is the same as indexOfMethod @@ -3741,7 +3763,8 @@ void QObject::dumpObjectInfo() } #ifndef QT_NO_USERDATA -/*!\internal +/*! + \internal */ uint QObject::registerUserData() { @@ -3749,13 +3772,15 @@ uint QObject::registerUserData() return user_data_registration++; } -/*!\internal +/*! + \internal */ QObjectUserData::~QObjectUserData() { } -/*!\internal +/*! + \internal */ void QObject::setUserData(uint id, QObjectUserData* data) { @@ -3768,7 +3793,8 @@ void QObject::setUserData(uint id, QObjectUserData* data) d->extraData->userData[id] = data; } -/*!\internal +/*! + \internal */ QObjectUserData* QObject::userData(uint id) const { @@ -4137,7 +4163,8 @@ void qDeleteInEventHandler(QObject *o) The connection will automatically disconnect if the sender is destroyed. */ -/** \internal +/** + \internal Implementation of the template version of connect diff --git a/src/corelib/kernel/qvariant.cpp b/src/corelib/kernel/qvariant.cpp index 2f73897df3..4b582affb3 100644 --- a/src/corelib/kernel/qvariant.cpp +++ b/src/corelib/kernel/qvariant.cpp @@ -1416,7 +1416,8 @@ QVariant::QVariant(Type type) QVariant::QVariant(int typeId, const void *copy) { create(typeId, copy); d.is_null = false; } -/*! \internal +/*! + \internal flags is true if it is a pointer type */ QVariant::QVariant(int typeId, const void *copy, uint flags) @@ -2843,7 +2844,8 @@ static bool qIsFloatingPoint(uint tp) return tp == QVariant::Double || tp == QMetaType::Float; } -/*! \internal +/*! + \internal */ bool QVariant::cmp(const QVariant &v) const { @@ -2861,7 +2863,8 @@ bool QVariant::cmp(const QVariant &v) const return handlerManager[d.type]->compare(&d, &v2.d); } -/*! \internal +/*! + \internal */ const void *QVariant::constData() const @@ -2875,7 +2878,9 @@ const void *QVariant::constData() const \internal */ -/*! \internal */ +/*! + \internal +*/ void* QVariant::data() { detach(); |