API dox: Use code markup for described dataUpdated slot signature

This commit is contained in:
Friedrich W. H. Kossebau 2018-01-16 11:42:20 +01:00
parent b5b4f2d3b8
commit 85193f8c75

View File

@ -103,8 +103,9 @@ public:
/**
* Connects a source to an object for data updates. The object must
* have a slot with the following signature:
*
* dataUpdated(const QString &sourceName, const Plasma::DataEngine::Data &data)
* @code
* void dataUpdated(const QString &sourceName, const Plasma::DataEngine::Data &data);
* @endcode
*
* The data is a QHash of QVariants keyed by QString names, allowing
* one data source to provide sets of related data.
@ -129,8 +130,9 @@ public:
/**
* Connects all currently existing sources to an object for data updates.
* The object must have a slot with the following signature:
*
* SLOT(dataUpdated(QString,Plasma::DataEngine::Data))
* @code
* void dataUpdated(const QString &sourceName, const Plasma::DataEngine::Data &data);
* @endcode
*
* The data is a QHash of QVariants keyed by QString names, allowing
* one data source to provide sets of related data.