feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

doc: Fix qdoc warnings in aggregation

Browse Source 
Change-Id: Ia9a2e6dcdb8dc82ae600b974e396fd8ac3a42678
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Eike Ziller
2020-02-17 16:59:34 +01:00
parent a854e0daa8
commit e2fad3afa4
2 changed files with 6 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/qtcreatordev/config/qtcreator-developer.qdocconf
View File

@@ -13,6 +13,8 @@ sourcedirs = . \
../../../src/libs/aggregation \ ../../../src/libs/aggregation \
../../../src/libs/extensionsystem ../../../src/libs/extensionsystem
excludedirs = ../../../src/libs/aggregation/examples
# -- Uncomment following option to generate complete documentation # -- Uncomment following option to generate complete documentation
# instead of public API documentation only. # instead of public API documentation only.
#showinternal = true #showinternal = true

18
src/libs/aggregation/aggregate.cpp
View File

@@ -104,7 +104,7 @@
*/ */
/*! /*!
\fn T *Aggregate::component() \fn template <typename T> T *Aggregation::Aggregate::component()
Template function that returns the component with the given type, if there is one. Template function that returns the component with the given type, if there is one.
If there are multiple components with that type, a random one is returned. If there are multiple components with that type, a random one is returned.
@@ -113,26 +113,16 @@
*/ */
/*! /*!
\fn QList<T *> Aggregate::components() \fn template <typename T> QList<T *> Aggregation::Aggregate::components()
Template function that returns all components with the given type, if there are any. Template function that returns all components with the given type, if there are any.
\sa Aggregate::component(), add() \sa Aggregate::component(), add()
*/ */
/*!
\fn T *Aggregation::query<T *>(Aggregate *obj)
\internal
*/
/*!
\fn QList<T *> Aggregation::query_all<T *>(Aggregate *obj)
\internal
*/
/*! /*!
\relates Aggregation::Aggregate \relates Aggregation::Aggregate
\fn T *Aggregation::query<T *>(QObject *obj) \fn template <typename T> T *Aggregation::query<T *>(QObject *obj)
Performs a dynamic cast that is aware of a possible aggregate that \a obj Performs a dynamic cast that is aware of a possible aggregate that \a obj
might belong to. If \a obj itself is of the requested type, it is simply cast might belong to. If \a obj itself is of the requested type, it is simply cast
@@ -144,7 +134,7 @@
/*! /*!
\relates Aggregation::Aggregate \relates Aggregation::Aggregate
\fn QList<T *> Aggregation::query_all<T *>(QObject *obj) \fn template <typename T> QList<T *> Aggregation::query_all<T *>(QObject *obj)
If \a obj belongs to an aggregate, all components that can be cast to the given If \a obj belongs to an aggregate, all components that can be cast to the given
type are returned. Otherwise, \a obj is returned if it is of the requested type. type are returned. Otherwise, \a obj is returned if it is of the requested type.