Commit 1c899458 authored by Kevin Krammer's avatar Kevin Krammer

Several API docs fixes

Fixing various API docs issues found by the EnglishBreakfastNetwork's
code checker Krazy.

Submitted by Kyle Morris <codeinkyle@gmail.com>, completing
a Google Code-in task.

CCMAIL: codeinkyle@gmail.com
REVIEW: 107991
DIGEST: Google Code-in contribution
parent 56ec5a1b
......@@ -133,9 +133,8 @@ class AKONADI_CONTACT_EXPORT ContactEditor : public QWidget
/**
* Sets a @p contact that is used as template in create mode.
*
* The fields of the editor will be prefilled with the content
* of the contact.
* The fields of the editor will be prefilled with the content of the contact.
* @param contact the contact to use as template content
*/
void setContactTemplate( const KABC::Addressee &contact );
......@@ -171,8 +170,7 @@ class AKONADI_CONTACT_EXPORT ContactEditor : public QWidget
/**
* This signal is emitted when an error occurred during the save.
*
* @p errorMsg The error message.
* @param errorMsg The error message.
*/
void error( const QString &errorMsg );
......
......@@ -126,9 +126,9 @@ class AKONADI_CONTACT_EXPORT ContactEditorDialog : public KDialog
/**
* Sets the @p contact to edit when in EditMode.
*
* @param contact the contact to edit
* @note The contact item just must have a uid set, all
* other data are fetched by the dialog automatically.
* other data are fetched by the dialog automatically.
*/
void setContact( const Akonadi::Item &contact );
......
......@@ -107,9 +107,8 @@ class AKONADI_CONTACT_EXPORT ContactGroupEditor : public QWidget
/**
* Sets a contact @p group that is used as template in create mode.
*
* The fields of the editor will be prefilled with the content
* of the group.
* The fields of the editor will be prefilled with the content of the group.
* @param group the group to use as template content
*/
void setContactGroupTemplate( const KABC::ContactGroup &group );
......@@ -143,8 +142,7 @@ class AKONADI_CONTACT_EXPORT ContactGroupEditor : public QWidget
/**
* This signal is emitted when an error occurred during the save.
*
* @p errorMsg The error message.
* @param errorMsg The error message.
*/
void error( const QString &errorMsg );
......
......@@ -98,7 +98,9 @@ class AKONADI_CONTACT_EXPORT ContactGroupSearchJob : public ItemSearchJob
/**
* Sets the @p criterion and @p value for the search with @p match.
*
* @param criterion the query criterion to compare with
* @param value the value to match against
* @param match how to match the given value
* @since 4.5
*/
void setQuery( Criterion criterion, const QString &value, Match match );
......@@ -108,8 +110,8 @@ class AKONADI_CONTACT_EXPORT ContactGroupSearchJob : public ItemSearchJob
* This is useful in situation where for example only the first search result is needed anyway,
* setting a limit of 1 here will greatly reduce the resource usage of Nepomuk during the
* search.
*
* This needs to be called before calling setQuery() to have an effect.
* @param limit the limit to set
* @note this needs to be called before calling setQuery() to have an effect.
* By default, the number of results is unlimited.
*
* @since 4.4.3
......
......@@ -79,9 +79,8 @@ class AKONADI_CONTACT_EXPORT ContactGroupViewer : public QWidget, public Akonadi
/**
* Sets the contact group @p formatter that should be used for formatting the
* contact group. If formatter is @c 0, the standard formatter will be used.
*
* @param formatter the formatter to use
* @note The contact viewer won't take ownership of the formatter.
*
* @since 4.6
*/
void setContactGroupFormatter( AbstractContactGroupFormatter *formatter );
......
......@@ -70,7 +70,7 @@ class ContactMetaData
/**
* Sets the @p descriptions of the custom fields of that contact.
*
* @param descriptions the descriptions to set
* The description list contains a QVariantMap for each custom field
* with the following keys:
* - key (string) The identifier of the field
......
......@@ -118,7 +118,8 @@ class AKONADI_CONTACT_EXPORT ContactSearchJob : public ItemSearchJob
/**
* Sets the @p criterion and @p value for the search.
*
* @param criterion the query criterion to compare with
* @param value the value to match against
* @note ExactMatch is used for the matching.
* @todo Merge with the method below in KDE5
*/
......@@ -126,19 +127,22 @@ class AKONADI_CONTACT_EXPORT ContactSearchJob : public ItemSearchJob
/**
* Sets the @p criterion and @p value for the search with @p match.
*
* @param criterion the query criterion to compare with
* @param value the value to match against
* @param match how to match the given value
* @since 4.5
*/
void setQuery( Criterion criterion, const QString &value, Match match );
/**
* Sets a @p limit on how many results will be returned by this search job.
*
* This is useful in situation where for example only the first search result is needed anyway,
* setting a limit of 1 here will greatly reduce the resource usage of Nepomuk during the
* search.
*
* This needs to be called before calling setQuery() to have an effect.
* By default, the number of results is unlimited.
* @param limit the upper limit for number of search results
*/
void setLimit( int limit );
......
......@@ -83,6 +83,7 @@ class AKONADI_CONTACT_EXPORT ContactsFilterProxyModel : public QSortFilterProxyM
/**
* Sets the filter @p flags. By default
* ContactsFilterProxyModel::FilterString is set.
* @param flags the filter flags to set
* @since 4.8
*/
void setFilterFlags( ContactsFilterProxyModel::FilterFlags flags );
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment