Commit 49efafed 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 Illya Kovalevskyy <illya.kovalevskyy@gmail.com>, completing
a Google Code-in task.

CCMAIL: illya.kovalevskyy@gmail.com
REVIEW: 107723
DIGEST: Google Code-in contribution
parent 32c0c79a
......@@ -37,8 +37,17 @@ class ContactMetaData;
class AbstractContactEditorWidget : public QWidget
{
public:
/**
* @param contact loads the given contact into the editor widget
*/
virtual void loadContact( const KABC::Addressee &contact, const Akonadi::ContactMetaData& ) = 0;
/**
* @param contact store the given contact into the editor widget
*/
virtual void storeContact( KABC::Addressee &contact, Akonadi::ContactMetaData& ) const = 0;
/**
* @param readOnly set read-only mode
*/
virtual void setReadOnly( bool readOnly ) = 0;
};
......
......@@ -79,6 +79,7 @@ class AKONADI_CONTACT_EXPORT AbstractContactFormatter
* Sets the @p item who's payload will be formatted.
*
* @note The payload must be a valid KABC::Addressee object.
* @param item item, who's payload will be formatted.
*/
void setItem( const Akonadi::Item &item );
......@@ -102,6 +103,8 @@ class AKONADI_CONTACT_EXPORT AbstractContactFormatter
* - date
* - time
* - datetime
*
* @param descriptions list with field descriptions
*/
void setCustomFieldDescriptions( const QList<QVariantMap> &descriptions );
......
......@@ -79,6 +79,8 @@ class AKONADI_CONTACT_EXPORT AbstractContactGroupFormatter
* Sets the @p item who's payload will be formatted.
*
* @note The payload must be a valid KABC::ContactGroup object.
*
* @param item item, who's payload will be formatted.
*/
void setItem( const Akonadi::Item &item );
......@@ -95,6 +97,8 @@ class AKONADI_CONTACT_EXPORT AbstractContactGroupFormatter
* - key (string) The identifier of the field
* - title (string) The i18n'ed title of the field
* - value (string) The value of the field
*
* @param fields additional fields that will be shown
*/
void setAdditionalFields( const QList<QVariantMap> &fields );
......
......@@ -54,6 +54,8 @@ class CollectionFilterModel : public QSortFilterProxyModel
* If a mime type has been added, only collections that contain
* this mime type in their content mime types will be listed by
* this proxy model.
*
* @param mimeType mime type content filter
*/
void addContentMimeTypeFilter( const QString &mimeType );
......@@ -62,6 +64,8 @@ class CollectionFilterModel : public QSortFilterProxyModel
*
* Only collections that allows this rights combination
* will be listed by this proxy model.
*
* @param rights collection rights filter
*/
void setRightsFilter( Akonadi::Collection::Rights rights );
......
......@@ -94,8 +94,8 @@ class AKONADI_CONTACT_EXPORT ContactEditor : public QWidget
};
enum DisplayMode {
FullMode, //Show all pages
VCardMode //Show just pages with elements stored in vcard.
FullMode, ///< Show all pages
VCardMode ///< Show just pages with elements stored in vcard.
};
/**
......@@ -115,12 +115,11 @@ class AKONADI_CONTACT_EXPORT ContactEditor : public QWidget
*/
ContactEditor( Mode mode, AbstractContactEditorWidget *editorWidget, QWidget *parent = 0 );
/**
* Creates a new contact editor dialog with a custom editor widget.
*
* @param mode The mode of the dialog.
* @param editorWidget The contact editor widget that shall be used for editing.
* @param displayMode mode for displaying the editor
* @param parent The parent widget of the dialog.
* @since 4.10
*/
......
......@@ -57,11 +57,13 @@ class AddressSelectionWidget : public KComboBox
/**
* Sets the list of @p addresses that can be chosen from.
* @param addresses list of addresses that can be chosen from
*/
void setAddresses( const KABC::Address::List &addresses );
/**
* Sets the current @p address.
* @param address new current address
*/
void setCurrentAddress( const KABC::Address &address );
......@@ -110,6 +112,7 @@ class AddressTypeCombo : public KComboBox
/**
* Sets the type that shall be selected in the combobox.
* @param type KABC adress type to set
*/
void setType( KABC::Address::Type type );
......
......@@ -90,8 +90,9 @@ class KDatePickerPopup: public QMenu
Q_SIGNALS:
/**
This signal emits the new date (selected with datepicker or other
This signal emits the new date (selected with datepicker or other
menu-items).
@param date changed date
*/
void dateChanged ( const QDate &date );
......
......@@ -43,9 +43,17 @@ class NameEditWidget : public QWidget
explicit NameEditWidget( QWidget *parent = 0 );
~NameEditWidget();
/**
* @param contact KABC contact's addressee to load
*/
void loadContact( const KABC::Addressee &contact );
/**
* @param contact KABC contact's addressee to store
*/
void storeContact( KABC::Addressee &contact ) const;
/**
* @param readOnly sets readonly mode
*/
void setReadOnly( bool readOnly );
Q_SIGNALS:
......
......@@ -38,8 +38,8 @@ class WaitingOverlay : public QWidget
public:
/**
* Create an overlay widget on @p baseWidget for @p job.
* @p baseWidget must not be null.
* @p parent must not be equal to @p baseWidget
* @param baseWidget must not be null.
* @param parent must not be equal to baseWidget
*/
explicit WaitingOverlay( KJob *job, QWidget *baseWidget, QWidget *parent = 0 );
~WaitingOverlay();
......
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