Add return docblock type

This commit is contained in:
2023-06-27 09:19:33 +01:00
parent 6d63e2f29b
commit f9e35368c0

View File

@@ -29,7 +29,7 @@ final class IconRuntime implements RuntimeExtensionInterface
* @param array $options * @param array $options
* ``` * ```
* $options = [ * $options = [
* 'icon' => (string) REQUIRED Icon name without trailing `.svg` * 'icon' => (string) **REQUIRED** Icon name without trailing `.svg`
* 'title' => (?string) Title text to appear on mouse hover * 'title' => (?string) Title text to appear on mouse hover
* 'size' => (int) Height and width in px * 'size' => (int) Height and width in px
* 'colour' => (string) Main colour * 'colour' => (string) Main colour
@@ -37,6 +37,8 @@ final class IconRuntime implements RuntimeExtensionInterface
* 'classes' => (array) Additional classes to add to the icon. Not recommended. * 'classes' => (array) Additional classes to add to the icon. Not recommended.
* ] * ]
* ``` * ```
*
* @return string Processed SVG
*/ */
public function renderIcon(array $userOptions): string public function renderIcon(array $userOptions): string
{ {