From 2b1cd9ef534eade1e35c4ceea1d278e0eea5d704 Mon Sep 17 00:00:00 2001
From: Yuri Chornoivan <yurchor@ukr.net>
Date: Mon, 31 Dec 2018 09:34:27 +0200
Subject: [PATCH] Fix minor Doxygen issues

---
 src/filter/filteractions/filteraction.h |  2 +-
 src/filter/kmfilterlistbox.h            |  3 ++-
 src/filter/mailfilter.h                 |  6 +++---
 src/search/searchpattern.h              |  2 +-
 src/search/searchrule/searchrule.h      | 11 ++++++++---
 src/snippets/snippetsmanager.h          |  1 +
 6 files changed, 16 insertions(+), 9 deletions(-)

diff --git a/src/filter/filteractions/filteraction.h b/src/filter/filteractions/filteraction.h
index f0244bb..8a57fc0 100644
--- a/src/filter/filteractions/filteraction.h
+++ b/src/filter/filteractions/filteraction.h
@@ -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
diff --git a/src/filter/kmfilterlistbox.h b/src/filter/kmfilterlistbox.h
index 7487220..007a167 100644
--- a/src/filter/kmfilterlistbox.h
+++ b/src/filter/kmfilterlistbox.h
@@ -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;
 
diff --git a/src/filter/mailfilter.h b/src/filter/mailfilter.h
index 647319f..50b0cef 100644
--- a/src/filter/mailfilter.h
+++ b/src/filter/mailfilter.h
@@ -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;
 
diff --git a/src/search/searchpattern.h b/src/search/searchpattern.h
index bbf89d6..11e838b 100644
--- a/src/search/searchpattern.h
+++ b/src/search/searchpattern.h
@@ -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;
 
     /**
diff --git a/src/search/searchrule/searchrule.h b/src/search/searchrule/searchrule.h
index 88e37c8..1c7d649 100644
--- a/src/search/searchrule/searchrule.h
+++ b/src/search/searchrule/searchrule.h
@@ -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.
      *
diff --git a/src/snippets/snippetsmanager.h b/src/snippets/snippetsmanager.h
index 5003ddd..9018dc5 100644
--- a/src/snippets/snippetsmanager.h
+++ b/src/snippets/snippetsmanager.h
@@ -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);