Fix minor Doxygen issues

wilder
Yuri Chornoivan 7 years ago
parent 33df49618e
commit 2b1cd9ef53
  1. 2
      src/filter/filteractions/filteraction.h
  2. 3
      src/filter/kmfilterlistbox.h
  3. 6
      src/filter/mailfilter.h
  4. 2
      src/search/searchpattern.h
  5. 11
      src/search/searchrule/searchrule.h
  6. 1
      src/snippets/snippetsmanager.h

@ -107,7 +107,7 @@ public:
/** /**
* Returns the required part from the item that is needed for the action to * 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; Q_REQUIRED_RESULT virtual SearchRule::RequiredPart requiredPart() const = 0;
/** /**
* Determines whether this action is valid. But this is just a * 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. * 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. * 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. * 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; QList<MailCommon::MailFilter *> filtersForSaving(bool closeAfterSaving, bool &wasCanceled) const;

@ -91,7 +91,7 @@ public:
*/ */
Q_REQUIRED_RESULT QString identifier() const; 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; Q_REQUIRED_RESULT QString name() const;
/** Execute the filter action(s) on the given message. /** Execute the filter action(s) on the given message.
@ -101,9 +101,9 @@ public:
the owner of the message, the owner of the message,
@li 0 if processed successfully. @li 0 if processed successfully.
@param context The context that contains the item to which the actions should be applied. @param context The context that contains the item to which the actions should be applied.
@param stopIt Contains @param stopIt Contains @c true if the caller may apply other filters and @c false if he shall
true if the caller may apply other filters and false if he shall
stop the filtering of this message. 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; 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 * 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; SearchRule::RequiredPart requiredPart() const;
/** /**

@ -73,10 +73,14 @@ public:
FuncNotEndWith FuncNotEndWith
}; };
/**
* @enum RequiredPart
* @brief Possible required parts.
*/
enum RequiredPart { enum RequiredPart {
Envelope = 0, Envelope = 0, ///< Envelope
Header, Header, ///< Header
CompleteMessage CompleteMessage ///< Whole message
}; };
/** /**
@ -172,6 +176,7 @@ public:
/** /**
* Saves the object into a given config @p group. * Saves the object into a given config @p group.
* *
* @param group The config group.
* @param index The identifier that is used to distinguish * @param index The identifier that is used to distinguish
* rules within a single config group. * rules within a single config group.
* *

@ -56,6 +56,7 @@ public:
* @param actionCollection The action collection where the manager will * @param actionCollection The action collection where the manager will
* register the snippet shortcuts at. * register the snippet shortcuts at.
* @param parent The parent object. * @param parent The parent object.
* @param widget The widget.
*/ */
explicit SnippetsManager(KActionCollection *actionCollection, QObject *parent = nullptr, QWidget *widget = nullptr); explicit SnippetsManager(KActionCollection *actionCollection, QObject *parent = nullptr, QWidget *widget = nullptr);

Loading…
Cancel
Save