Improve documentation

This commit is contained in:
Martchus 2021-09-13 18:24:22 +02:00
parent 56fdef53cd
commit c5f17009aa
2 changed files with 7 additions and 0 deletions

3
icon.h
View File

@ -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"

View File

@ -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);