Commit 9165a026 authored by Kevin Funk's avatar Kevin Funk

Fix some -Wdocumentation warnings

parent 6b5b444a
......@@ -185,7 +185,7 @@ public:
*
* @deprecated Use ObserverV2 instead
*/
class AKONADIAGENTBASE_EXPORT Observer // krazy:exclude=dpointer
class AKONADIAGENTBASE_DEPRECATED AKONADIAGENTBASE_EXPORT Observer // krazy:exclude=dpointer
{
public:
/**
......@@ -319,7 +319,7 @@ public:
* flag changes via Observer::itemChanged(), even when you don't reimplement
* itemsFlagsChanged()!
*
* @param item The changed item.
* @param items The changed items
* @param addedFlags Flags that have been added to the item
* @param removedFlags Flags that have been removed from the item
*/
......
......@@ -33,11 +33,11 @@ public:
~AgentPluginLoader();
/**
Returns the loader for plugins with @param pluginName. Callers must not
Returns the loader for plugins with @p pluginName. Callers must not
take ownership over the returned loader. Loaders will be unloaded and deleted
when the AgentPluginLoader goes out of scope/gets deleted.
@return the plugin for @param pluginName or 0 if the plugin is not found.
@return the plugin for @p pluginName or 0 if the plugin is not found.
*/
QPluginLoader *load(const QString &pluginName);
......
......@@ -412,7 +412,7 @@ public:
*
* The default is @c false.
*
* @param fetchTags whether or not to load relations.
* @param fetchRelations whether or not to load relations.
* @since 4.15
*/
void setFetchRelations(bool fetchRelations);
......
......@@ -78,7 +78,7 @@ public:
* metatype-id \a metaTypeId.
* Throws ItemSerializerException or returns an Item w/o payload on failure.
* @param item the item to convert
* @param metaTypeID the meta type id used to convert items payload
* @param metaTypeId the meta type id used to convert items payload
* @since 4.6
*/
static Item convert(const Item &item, int metaTypeId);
......
......@@ -73,7 +73,6 @@ public:
/**
* Creates an invalid search job.
*
* @param query The search query.
* @param parent The parent object.
* @since 5.1
*/
......
......@@ -94,7 +94,7 @@ public:
/**
* Notify following jobs about item revision changes.
* This is used to avoid phantom conflicts between pipelined modify jobs on the same item.
* @param itemID the id of the item which has changed
* @param itemId the id of the item which has changed
* @param oldRevision the old item revision
* @param newRevision the new item revision
*/
......
......@@ -69,9 +69,9 @@ public:
/**
* Creates a search create job
*
* @param name The name of the search collection.
* @param query The search query.
* @param parent The parent object.
* @param name The name of the search collection
* @param searchQuery The search query
* @param parent The parent object
* @since 4.13
*/
SearchCreateJob(const QString &name, const SearchQuery &searchQuery, QObject *parent = nullptr);
......
......@@ -118,7 +118,7 @@ Q_SIGNALS:
/**
* This signal is emitted whenever new tags have been fetched completely.
*
* @param items The fetched tags.
* @param tags The fetched tags
*/
void tagsReceived(const Akonadi::Tag::List &tags);
......
......@@ -87,7 +87,7 @@ public:
* Returns the list of favorite collections.
* @deprecated Use collectionIds instead.
*/
Collection::List collections() const;
AKONADICORE_DEPRECATED Collection::List collections() const;
/**
* Returns the list of ids of favorite collections set on the FavoriteCollectionsModel.
......
......@@ -273,7 +273,6 @@ public:
*
* @param enable @c true to enable the feature, @c false means everything
* that was requested will be fetched.
* @return void
*/
void fetchChangedOnly(bool enable);
......
......@@ -111,7 +111,7 @@ public:
/**
* Sets IDs of collections to be queries
* @param collectionsIDs IDs of collections to query
* @param collectionsIds IDs of collections to query
* @since 4.13
*/
void setQueryCollections(const QList<qint64> &collectionsIds);
......
......@@ -72,21 +72,21 @@ public:
/**
* Find a handler for a command that is always allowed, like LOGOUT.
* @param line the command string
* @param cmd the command string
* @return an instance to the handler. The handler is deleted after @see handelLine is executed. The caller needs to delete the handler in case an exception is thrown from handelLine.
*/
static Handler *findHandlerForCommandAlwaysAllowed(Protocol::Command::Type cmd);
/**
* Find a handler for a command that is allowed when the client is not yet authenticated, like LOGIN.
* @param line the command string
* @param cmd the command string
* @return an instance to the handler. The handler is deleted after @see handelLine is executed. The caller needs to delete the handler in case an exception is thrown from handelLine.
*/
static Handler *findHandlerForCommandNonAuthenticated(Protocol::Command::Type cmd);
/**
* Find a handler for a command that is allowed when the client is authenticated, like LIST, FETCH, etc.
* @param line the command string
* @param cmd the command string
* @return an instance to the handler. The handler is deleted after @see handelLine is executed. The caller needs to delete the handler in case an exception is thrown from handelLine.
*/
static Handler *findHandlerForCommandAuthenticated(Protocol::Command::Type cmd);
......
......@@ -43,15 +43,11 @@ public:
/**
* Adds the given @p collection to the search.
*
* @returns true if the collection was added successfully, false otherwise.
*/
virtual void addSearch(const Collection &collection) = 0;
/**
* Removes the collection with the given @p id from the search.
*
* @returns true if the collection was removed successfully, false otherwise.
*/
virtual void removeSearch(qint64 id) = 0;
};
......
......@@ -49,7 +49,6 @@ public:
QStringList tagToStringList() const;
/**
* @brief setSelectionFromStringList, convert a QStringList to Tag (converted from url)
* @param lst
*/
void setSelectionFromStringList(const QStringList &lst);
private:
......
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