[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-commits
Subject: [kdepimlibs] /: Several API docs fixes
From: Kevin Krammer <krammer () kde ! org>
Date: 2012-12-31 15:50:37
Message-ID: 20121231155037.DC451A6091 () git ! kde ! org
[Download RAW message or body]
Git commit ea9394edd06031774d6e82faa2784840405efa8f by Kevin Krammer.
Committed on 31/12/2012 at 16:45.
Pushed by krake into branch 'master'.
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: 108038
DIGEST: Google Code-in contribution
M +5 -0 akonadi/calendar/standardcalendaractionmanager.h
M +6 -0 akonadi/contact/standardcontactactionmanager.h
M +1 -0 akonadi/subscriptiondialog_p.h
M +1 -0 akonadi/subscriptionmodel_p.h
M +1 -1 akonadi/transactionsequence.h
M +1 -0 akonadi/trashrestorejob.h
M +1 -1 kabc/contactgroup.h
M +1 -1 kabc/picture.h
M +1 -0 kalarmcal/alarmtext.h
M +2 -0 kimap/acl.h
M +1 -1 kimap/getquotajob.h
M +1 -0 kimap/imapset.h
M +35 -9 kldap/ldapconfigwidget.h
http://commits.kde.org/kdepimlibs/ea9394edd06031774d6e82faa2784840405efa8f
diff --git a/akonadi/calendar/standardcalendaractionmanager.h \
b/akonadi/calendar/standardcalendaractionmanager.h index b1a45ba..347c2e1 100644
--- a/akonadi/calendar/standardcalendaractionmanager.h
+++ b/akonadi/calendar/standardcalendaractionmanager.h
@@ -79,12 +79,14 @@ public:
* Sets the collection selection model based on which the collection
* related actions should operate. If none is set, all collection actions
* will be disabled.
+ * @param selectionModel the selection model for collections
*/
void setCollectionSelectionModel( QItemSelectionModel *selectionModel );
/**
* Sets the item selection model based on which the item related actions
* should operate. If none is set, all item actions will be disabled.
+ * @param selectionModel the selection model for items
*/
void setItemSelectionModel( QItemSelectionModel *selectionModel );
@@ -92,6 +94,7 @@ public:
* Creates the action of the given type and adds it to the action collection
* specified in the constructor if it does not exist yet. The action is
* connected to its default implementation provided by this class.
+ * @param type the type of action to create
*/
KAction* createAction( Type type );
@@ -99,6 +102,7 @@ public:
* Creates the action of the given type and adds it to the action collection
* specified in the constructor if it does not exist yet. The action is
* connected to its default implementation provided by this class.
+ * @param type the type of action to create
*/
KAction* createAction( StandardActionManager::Type type );
@@ -115,6 +119,7 @@ public:
/**
* Returns the action of the given type, 0 if it has not been created (yet).
+ * @param type the type of action to return
*/
KAction* action( StandardActionManager::Type type ) const;
diff --git a/akonadi/contact/standardcontactactionmanager.h \
b/akonadi/contact/standardcontactactionmanager.h index 45454ad..03064d9 100644
--- a/akonadi/contact/standardcontactactionmanager.h
+++ b/akonadi/contact/standardcontactactionmanager.h
@@ -75,12 +75,14 @@ class AKONADI_CONTACT_EXPORT StandardContactActionManager : \
public QObject
* Sets the collection selection model based on which the collection
* related actions should operate. If none is set, all collection actions
* will be disabled.
+ * @param selectionModel the selection model for collections
*/
void setCollectionSelectionModel( QItemSelectionModel *selectionModel );
/**
* Sets the item selection model based on which the item related actions
* should operate. If none is set, all item actions will be disabled.
+ * @param selectionModel the selection model for items
*/
void setItemSelectionModel( QItemSelectionModel* selectionModel );
@@ -88,6 +90,7 @@ class AKONADI_CONTACT_EXPORT StandardContactActionManager : public \
QObject
* Creates the action of the given type and adds it to the action collection
* specified in the constructor if it does not exist yet. The action is
* connected to its default implementation provided by this class.
+ * @param type the type of action to create
*/
KAction* createAction( Type type );
@@ -95,6 +98,7 @@ class AKONADI_CONTACT_EXPORT StandardContactActionManager : public \
QObject
* Creates the action of the given type and adds it to the action collection
* specified in the constructor if it does not exist yet. The action is
* connected to its default implementation provided by this class.
+ * @param type the type of action to create
*/
KAction* createAction( StandardActionManager::Type type );
@@ -111,6 +115,7 @@ class AKONADI_CONTACT_EXPORT StandardContactActionManager : \
public QObject
/**
* Returns the action of the given type, 0 if it has not been created (yet).
+ * @param type the type of action to return
*/
KAction* action( StandardActionManager::Type type ) const;
@@ -159,6 +164,7 @@ class AKONADI_CONTACT_EXPORT StandardContactActionManager : \
public QObject Akonadi::Item::List selectedItems() const;
/**
+ * @param names the list of names to set as collection properties page names
* @since 4.8.2
*/
void setCollectionPropertiesPageNames( const QStringList &names );
diff --git a/akonadi/subscriptiondialog_p.h b/akonadi/subscriptiondialog_p.h
index b59ce74..85b0706 100644
--- a/akonadi/subscriptiondialog_p.h
+++ b/akonadi/subscriptiondialog_p.h
@@ -61,6 +61,7 @@ class AKONADI_EXPORT SubscriptionDialog : public KDialog
~SubscriptionDialog();
/**
+ * @param showHidden shows hidden collections if set as @c true
* @since 4.9
*/
void showHiddenCollection(bool showHidden);
diff --git a/akonadi/subscriptionmodel_p.h b/akonadi/subscriptionmodel_p.h
index f1d146d..d72e4fe 100644
--- a/akonadi/subscriptionmodel_p.h
+++ b/akonadi/subscriptionmodel_p.h
@@ -59,6 +59,7 @@ class SubscriptionModel : public CollectionModel
Collection::List unsubscribed() const;
/**
+ * @param showHidden shows hidden collection if set as @c true
* @since: 4.9
*/
void showHiddenCollection(bool showHidden);
diff --git a/akonadi/transactionsequence.h b/akonadi/transactionsequence.h
index 5815377..b45dd6f 100644
--- a/akonadi/transactionsequence.h
+++ b/akonadi/transactionsequence.h
@@ -99,7 +99,7 @@ class AKONADI_EXPORT TransactionSequence : public Job
/**
* Sets which job of the sequence might fail without rolling back the
* complete transaction.
- *
+ * @param job a job to ignore errors from
* @since 4.5
*/
void setIgnoreJobFailure( KJob *job );
diff --git a/akonadi/trashrestorejob.h b/akonadi/trashrestorejob.h
index 0f0e03c..1838d85 100644
--- a/akonadi/trashrestorejob.h
+++ b/akonadi/trashrestorejob.h
@@ -72,6 +72,7 @@ class AKONADI_EXPORT TrashRestoreJob : public Job
/**
* Sets the target collection, where the item is moved to.
* If not set the item will be restored in the collection saved in the \
EntityDeletedAttribute. + * @param collection the collection to set as target
*/
void setTargetCollection( const Collection collection );
diff --git a/kabc/contactgroup.h b/kabc/contactgroup.h
index bfdb193..70353b1 100644
--- a/kabc/contactgroup.h
+++ b/kabc/contactgroup.h
@@ -80,7 +80,7 @@ class KABC_EXPORT ContactGroup
/**
* Sets the contact uid of the contact reference.
- *
+ * @param uid identifier of the contact to reference
* @note That is the Akonadi Item ID of the contact that
* is referenced here.
*/
diff --git a/kabc/picture.h b/kabc/picture.h
index b3b5a7f..d76d0da 100644
--- a/kabc/picture.h
+++ b/kabc/picture.h
@@ -140,7 +140,7 @@ class KABC_EXPORT Picture
/**
* Sets the type of the picture.
- *
+ * @param type the picture's data type
* @deprecated type should only be set along with setRawData()
*/
void KDE_DEPRECATED setType( const QString &type );
diff --git a/kalarmcal/alarmtext.h b/kalarmcal/alarmtext.h
index b20a745..9c77a6a 100644
--- a/kalarmcal/alarmtext.h
+++ b/kalarmcal/alarmtext.h
@@ -68,6 +68,7 @@ class KALARMCAL_EXPORT AlarmText
/** Set the alarm text.
* If @p text starts with '#!', it is flagged as a script, else plain text.
+ * @param the text to set for alarm
*/
void setText(const QString& text);
diff --git a/kimap/acl.h b/kimap/acl.h
index c200d19..2df610c 100644
--- a/kimap/acl.h
+++ b/kimap/acl.h
@@ -94,12 +94,14 @@ Q_DECLARE_FLAGS( Rights, Right )
/**
* Returns a rights mask that has no obsolete members anymore, i.e. obsolete flags \
are removed and
* replaced by their successors.
+ * @param rights set of #Rights flags to normalize
* @since 4.6
*/
KIMAP_EXPORT Rights normalizedRights( Rights rights );
/**
* Returns a rights mask that contains both obsolete and new flags if one of them is \
set. + * @param rights set of #Rights flags to augment
* @since 4.6
*/
KIMAP_EXPORT Rights denormalizedRights( Rights rights );
diff --git a/kimap/getquotajob.h b/kimap/getquotajob.h
index e332b36..698450a 100644
--- a/kimap/getquotajob.h
+++ b/kimap/getquotajob.h
@@ -60,7 +60,7 @@ class KIMAP_EXPORT GetQuotaJob : public QuotaJobBase
/**
* Set the quota root to get the resource limits for.
- *
+ * @param root the quota root to set
* @see GetQuotaRootJob
*/
void setRoot(const QByteArray &root);
diff --git a/kimap/imapset.h b/kimap/imapset.h
index a3417ac..a217251 100644
--- a/kimap/imapset.h
+++ b/kimap/imapset.h
@@ -199,6 +199,7 @@ class KIMAP_EXPORT ImapSet
/**
Adds the given ImapInterval to this set.
No interval merging is performed.
+ @param interval the interval to add
*/
void add( const ImapInterval &interval );
diff --git a/kldap/ldapconfigwidget.h b/kldap/ldapconfigwidget.h
index d871410..65e04c8 100644
--- a/kldap/ldapconfigwidget.h
+++ b/kldap/ldapconfigwidget.h
@@ -103,12 +103,16 @@ class KLDAP_EXPORT LdapConfigWidget : public QWidget
/** Destructs a configuration widget */
virtual ~LdapConfigWidget();
- /** Sets the user name. Kconfig widget name: kcfg_ldapuser */
+ /** Sets the user name. Kconfig widget name: kcfg_ldapuser
+ * @param user the user name to set
+ */
void setUser( const QString &user );
/** Gets the user name. Kconfig widget name: kcfg_ldapuser */
QString user() const;
- /** Sets the password. Kconfig widget name: kcfg_ldappassword */
+ /** Sets the password. Kconfig widget name: kcfg_ldappassword
+ * @param password the password to set
+ */
void setPassword( const QString &password );
/** Gets the password. Kconfig widget name: kcfg_ldappassword */
QString password() const;
@@ -116,42 +120,57 @@ class KLDAP_EXPORT LdapConfigWidget : public QWidget
/**
* Sets the bind dn.
* Kconfig widget name: kcfg_ldapbinddn
+ * @param binddn the LDAP Bind DN to set
*/
void setBindDn( const QString &binddn );
/** Gets the bind dn. Kconfig widget name: kcfg_ldapbinddn*/
QString bindDn() const;
- /** Sets the SASL realm. Kconfig widget name: kcfg_ldaprealm */
+ /** Sets the SASL realm. Kconfig widget name: kcfg_ldaprealm
+ * @param realm the SASL realm to set
+ */
void setRealm( const QString &realm );
/** Gets the SASL realm. Kconfig widget name: kcfg_ldaprealm */
QString realm() const;
- /** Sets the host name. Kconfig widget name: kcfg_ldaphost */
+ /** Sets the host name. Kconfig widget name: kcfg_ldaphost
+ * @param host the LDAP host to set
+ */
void setHost( const QString &host );
/** Gets the host name. Kconfig widget name: kcfg_ldaphost */
QString host() const;
- /** Sets the LDAP port. Kconfig widget name: kcfg_ldapport */
+ /** Sets the LDAP port. Kconfig widget name: kcfg_ldapport
+ * @param port the LDAP port to set
+ */
void setPort( int port );
/** Gets the LDAP port. Kconfig widget name: kcfg_ldapport */
int port() const;
- /** Sets the LDAP protocol version. Kconfig widget name: kcfg_ldapver */
+ /** Sets the LDAP protocol version. Kconfig widget name: kcfg_ldapver
+ * @param version the LDAP protocol version to set
+ */
void setVersion( int version );
/** Gets the LDAP protocol version. Kconfig widget name: kcfg_ldapver */
int version() const;
- /** Sets the LDAP Base DN. Kconfig widget name: kcfg_ldapdn */
+ /** Sets the LDAP Base DN. Kconfig widget name: kcfg_ldapdn
+ * @param dn the LDAP Base DN to set
+ */
void setDn( const LdapDN &dn );
/** Gets the LDAP Base DN. Kconfig widget name: kcfg_ldapdn */
LdapDN dn() const;
- /** Sets the LDAP Filter. Kconfig widget name: kcfg_ldapfilter */
+ /** Sets the LDAP Filter. Kconfig widget name: kcfg_ldapfilter
+ * @param filter the LDAP Filter to set
+ */
void setFilter( const QString &filter );
/** Gets the LDAP Filter. Kconfig widget name: kcfg_ldapfilter */
QString filter() const;
- /** Sets the SASL Mechanism. Kconfig widget name: kcfg_ldapsaslmech */
+ /** Sets the SASL Mechanism. Kconfig widget name: kcfg_ldapsaslmech
+ * @param mech the SASL Mechanism to set
+ */
void setMech( const QString &mech );
/** Gets the SASL Mechanism. Kconfig widget name: kcfg_ldapsaslmech */
QString mech() const;
@@ -159,6 +178,7 @@ class KLDAP_EXPORT LdapConfigWidget : public QWidget
/**
* Sets the security type (None, SSL, TLS).
* Kconfig widget names: kcfg_ldapnosec, kcfg_ldaptls, kcfg_ldapssl
+ * @param security the security type to set
*/
void setSecurity( Security security );
/**
@@ -170,6 +190,7 @@ class KLDAP_EXPORT LdapConfigWidget : public QWidget
/**
* Sets the authentication type (Anonymous, Simple, SASL).
* Kconfig widget names: kcfg_ldapanon, kcfg_ldapsimple, kcfg_ldapsasl
+ * @param auth the authentication type to set
*/
void setAuth( Auth auth );
/**
@@ -181,6 +202,7 @@ class KLDAP_EXPORT LdapConfigWidget : public QWidget
/**
* Sets the size limit.
* KConfig widget name: kcfg_ldapsizelimit
+ * @param sizelimit the size limit to set
*/
void setSizeLimit( int sizelimit );
/**
@@ -192,6 +214,7 @@ class KLDAP_EXPORT LdapConfigWidget : public QWidget
/**
* Sets the time limit.
* KConfig widget name: kcfg_ldaptimelimit
+ * @param timelimit the time limit to set
*/
void setTimeLimit( int timelimit );
/**
@@ -203,6 +226,7 @@ class KLDAP_EXPORT LdapConfigWidget : public QWidget
/**
* Sets the page size.
* KConfig widget name: kcfg_ldappagesize
+ * @param pagesize the page size to set
*/
void setPageSize( int pagesize );
/**
@@ -221,6 +245,7 @@ class KLDAP_EXPORT LdapConfigWidget : public QWidget
LdapUrl url() const;
/**
* Set up the widget via an LDAP Url.
+ * @param url the LDAP Url to set
*/
void setUrl( const LdapUrl &url );
@@ -230,6 +255,7 @@ class KLDAP_EXPORT LdapConfigWidget : public QWidget
LdapServer server() const;
/**
* Set up the widget via an LdapServer object.
+ * @param server the LdapServer object to set
*/
void setServer( const LdapServer &server );
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic