Members of the KDE Community are recommended to subscribe to the kde-community mailing list at https://mail.kde.org/mailman/listinfo/kde-community to allow them to participate in important discussions and receive other important announcements

Commit 2b1cd9ef authored by Yuri Chornoivan's avatar Yuri Chornoivan

Fix minor Doxygen issues

parent 33df4961
......@@ -107,7 +107,7 @@ public:
/**
* Returns the required part from the item that is needed for the action to
* operate. See @ref SearchRule::RequiredPart */
* operate. See @ref MailCommon::SearchRule::RequiredPart */
Q_REQUIRED_RESULT virtual SearchRule::RequiredPart requiredPart() const = 0;
/**
* Determines whether this action is valid. But this is just a
......
......@@ -104,8 +104,9 @@ public:
/**
* Returns a list of _copies_ of the current list of filters.
* The list owns the contents and thus the caller needs to clean them up.
* @param closeAfterSaving If true user is given option to continue editing
* @param closeAfterSaving If @c true user is given option to continue editing
* after being warned about invalid filters. Otherwise, user is just warned.
* @param wasCanceled If @c true then the operation was canceled.
*/
QList<MailCommon::MailFilter *> filtersForSaving(bool closeAfterSaving, bool &wasCanceled) const;
......
......@@ -91,7 +91,7 @@ public:
*/
Q_REQUIRED_RESULT QString identifier() const;
/** Equivalent to @pattern()->name(). @return name of the filter */
/** Equivalent to @p pattern()->name(). @return name of the filter */
Q_REQUIRED_RESULT QString name() const;
/** Execute the filter action(s) on the given message.
......@@ -101,9 +101,9 @@ public:
the owner of the message,
@li 0 if processed successfully.
@param context The context that contains the item to which the actions should be applied.
@param stopIt Contains
true if the caller may apply other filters and false if he shall
@param stopIt Contains @c true if the caller may apply other filters and @c false if he shall
stop the filtering of this message.
@param applyOnOutbound Defines whether to apply the rules on the outbound.
*/
Q_REQUIRED_RESULT ReturnCode execActions(ItemContext &context, bool &stopIt, bool applyOnOutbound) const;
......
......@@ -120,7 +120,7 @@ public:
/**
* Returns the required part from the item that is needed for the search to
* operate. See @ref RequiredPart */
* operate. See @ref SearchRule::RequiredPart */
SearchRule::RequiredPart requiredPart() const;
/**
......
......@@ -73,10 +73,14 @@ public:
FuncNotEndWith
};
/**
* @enum RequiredPart
* @brief Possible required parts.
*/
enum RequiredPart {
Envelope = 0,
Header,
CompleteMessage
Envelope = 0, ///< Envelope
Header, ///< Header
CompleteMessage ///< Whole message
};
/**
......@@ -172,6 +176,7 @@ public:
/**
* Saves the object into a given config @p group.
*
* @param group The config group.
* @param index The identifier that is used to distinguish
* rules within a single config group.
*
......
......@@ -56,6 +56,7 @@ public:
* @param actionCollection The action collection where the manager will
* register the snippet shortcuts at.
* @param parent The parent object.
* @param widget The widget.
*/
explicit SnippetsManager(KActionCollection *actionCollection, QObject *parent = nullptr, QWidget *widget = nullptr);
......
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