Update docblock

This commit is contained in:
brabli
2025-02-26 09:55:28 +00:00
parent 6883382420
commit ebc73e1b24

View File

@@ -7,10 +7,15 @@ namespace Pcm\BadgeBundle\Interface;
use Pcm\BadgeBundle\Enum\Badge; 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 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; public function getBadgeColour(): Badge;
} }