From c5f17009aaf171554b31c95e26f138f1624f1e3c Mon Sep 17 00:00:00 2001
From: Martchus <martchus@gmx.net>
Date: Mon, 13 Sep 2021 18:24:22 +0200
Subject: [PATCH] Improve documentation

---
 icon.h  | 3 +++
 utils.h | 4 ++++
 2 files changed, 7 insertions(+)

diff --git a/icon.h b/icon.h
index 61fd585..6b12417 100644
--- a/icon.h
+++ b/icon.h
@@ -5,6 +5,9 @@
 
 namespace QtForkAwesome {
 
+/*!
+ * \brief The Icon enum specifies a ForkAwesome icon for calling QtForkAwesome::Renderer::render().
+ */
 enum class Icon : IconBaseType {
     Invalid, /**< invalid, used by QtForkAwesome::iconFromId() to indicate failure */
 #include "private/icons.h"
diff --git a/utils.h b/utils.h
index 1de8edd..7794328 100644
--- a/utils.h
+++ b/utils.h
@@ -8,6 +8,10 @@ QT_FORWARD_DECLARE_CLASS(QString)
 
 namespace QtForkAwesome {
 
+/*!
+ * \brief Returns whether \a icon is not Icon::Invalid.
+ * \remarks Allows one to avoid including `icon.h` just for this check.
+ */
 constexpr bool isIconValid(Icon icon)
 {
     return static_cast<IconBaseType>(icon);