From ebc73e1b24e2cfeea7724a0aa238fb0fcb73a770 Mon Sep 17 00:00:00 2001
From: brabli <67018167+brabli@users.noreply.github.com>
Date: Wed, 26 Feb 2025 09:55:28 +0000
Subject: [PATCH] Update docblock

---
 src/Interface/BadgeableInterface.php | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/Interface/BadgeableInterface.php b/src/Interface/BadgeableInterface.php
index 4b1f907..29a23e8 100644
--- a/src/Interface/BadgeableInterface.php
+++ b/src/Interface/BadgeableInterface.php
@@ -7,10 +7,15 @@ namespace Pcm\BadgeBundle\Interface;
 use Pcm\BadgeBundle\Enum\Badge;
 
 /**
- * Enables this class to be rendered as a badge using the Badge and BadgeOutline Twig components.
+ * Allows rendering the implementing class as a badge using the PCM Badge twig component.
  */
 interface BadgeableInterface
 {
+    /**
+     * Get the badge colour that should be used when rendering this object as a badge.
+     *
+     * @return Badge Colour of badge to render
+     */
     public function getBadgeColour(): Badge;
 }