API dox: use @param for normal parameter listing, not @arg
This commit is contained in:
parent
f0cc90e45d
commit
0e1219d03b
@ -122,7 +122,7 @@ public:
|
|||||||
* This allows the item data to be accessed (but not modified) from JavaScript.
|
* This allows the item data to be accessed (but not modified) from JavaScript.
|
||||||
* It returns an Object with a property for each role.
|
* It returns an Object with a property for each role.
|
||||||
*
|
*
|
||||||
* @arg int i the row we want
|
* @param i the row we want
|
||||||
*/
|
*/
|
||||||
Q_INVOKABLE QVariantMap get(int i) const;
|
Q_INVOKABLE QVariantMap get(int i) const;
|
||||||
|
|
||||||
@ -222,7 +222,7 @@ public:
|
|||||||
* This allows the item data to be accessed (but not modified) from JavaScript.
|
* This allows the item data to be accessed (but not modified) from JavaScript.
|
||||||
* It returns an Object with a property for each role.
|
* It returns an Object with a property for each role.
|
||||||
*
|
*
|
||||||
* @arg int i the row we want
|
* @param i the row we want
|
||||||
*/
|
*/
|
||||||
Q_INVOKABLE QVariantMap get(int i) const;
|
Q_INVOKABLE QVariantMap get(int i) const;
|
||||||
|
|
||||||
|
@ -143,7 +143,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns a Plasma::Service given a source name
|
* @returns a Plasma::Service given a source name
|
||||||
* @arg QString source source name we want a service of
|
* @param source source name we want a service of
|
||||||
*/
|
*/
|
||||||
Q_INVOKABLE QObject *serviceForSource(const QString &source);
|
Q_INVOKABLE QObject *serviceForSource(const QString &source);
|
||||||
|
|
||||||
|
@ -88,7 +88,7 @@ public:
|
|||||||
/**
|
/**
|
||||||
* Default constructor
|
* Default constructor
|
||||||
*
|
*
|
||||||
* @arg structure if a NULL pointer is passed in, this will creates an empty (invalid) Package;
|
* @param structure if a NULL pointer is passed in, this will creates an empty (invalid) Package;
|
||||||
* otherwise the structure is allowed to set up the Package's initial layout
|
* otherwise the structure is allowed to set up the Package's initial layout
|
||||||
* @since 4.6
|
* @since 4.6
|
||||||
*/
|
*/
|
||||||
|
@ -54,8 +54,8 @@ public:
|
|||||||
* compatible .desktop file within the package. If not defined, it is assumed that this file
|
* compatible .desktop file within the package. If not defined, it is assumed that this file
|
||||||
* exists under the top level directory of the package.
|
* exists under the top level directory of the package.
|
||||||
*
|
*
|
||||||
* @arg package the Package to set up. The object is empty of all definition when
|
* @param package the Package to set up. The object is empty of all definition when
|
||||||
* first passed in.
|
* first passed in.
|
||||||
*/
|
*/
|
||||||
PLASMA_DEPRECATED virtual void initPackage(Package *package);
|
PLASMA_DEPRECATED virtual void initPackage(Package *package);
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user