[DOCS] Add admonition directive docs

Author: jaapio

src/RestructuredText/Directives/AttentionDirective.php

@@ -15,6 +15,17 @@
 
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 
+/**
+ * Directive to create an attention admonition.
+ *
+ * Example:
+ *
+ * ```rest
+ *  .. attention::
+ *
+ *      This is an attention admonition.
+ * ```
+ */
 final class AttentionDirective extends AbstractAdmonitionDirective
 {
     public function __construct(protected Rule $startingRule)

src/RestructuredText/Directives/CautionDirective.php

@@ -15,6 +15,17 @@
 
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 
+/**
+ * Directive to create a caution admonition.
+ *
+ * Example:
+ *
+ * ```rest
+ *  .. caution::
+ *
+ *      This is a caution admonition.
+ * ```
+ */
 final class CautionDirective extends AbstractAdmonitionDirective
 {
     public function __construct(protected Rule $startingRule)

src/RestructuredText/Directives/DangerDirective.php

@@ -15,7 +15,18 @@
 
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 
-final class DangerDirective extends AbstractAdmonitionDirective
+/**
+ * Directive to create a danger admonition.
+ *
+ * Example:
+ *
+ * ```rest
+ *  .. danger::
+ *
+ *      This is a danger admonition.
+ * ```
+ */
+class DangerDirective extends AbstractAdmonitionDirective
 {
     public function __construct(protected Rule $startingRule)
     {

src/RestructuredText/Directives/ErrorDirective.php

@@ -15,6 +15,17 @@
 
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 
+/**
+ * Directive to create a error admonition.
+ *
+ * Example:
+ *
+ * ```rest
+ *  .. error::
+ *
+ *      This is an error admonition.
+ * ```
+ */
 final class ErrorDirective extends AbstractAdmonitionDirective
 {
     public function __construct(protected Rule $startingRule)

src/RestructuredText/Directives/HintDirective.php

@@ -15,6 +15,17 @@
 
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 
+/**
+ * Directive to create a hint admonition.
+ *
+ * Example:
+ *
+ * ```rest
+ *  .. hint::
+ *
+ *      This is a hint admonition.
+ * ```
+ */
 final class HintDirective extends AbstractAdmonitionDirective
 {
     public function __construct(protected Rule $startingRule)

src/RestructuredText/Directives/ImportantDirective.php

@@ -15,6 +15,17 @@
 
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 
+/**
+ * Directive to create a important admonition.
+ *
+ * Example:
+ *
+ * ```rest
+ *  .. important::
+ *
+ *      This is a important admonition.
+ * ```
+ */
 final class ImportantDirective extends AbstractAdmonitionDirective
 {
     public function __construct(protected Rule $startingRule)

src/RestructuredText/Directives/NoteDirective.php

@@ -15,6 +15,17 @@
 
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 
+/**
+ * Directive to create a note admonition.
+ *
+ * Example:
+ *
+ * ```rest
+ *  .. note::
+ *
+ *      This is a note admonition.
+ * ```
+ */
 final class NoteDirective extends AbstractAdmonitionDirective
 {
     public function __construct(protected Rule $startingRule)

src/RestructuredText/Directives/SeeAlsoDirective.php

@@ -15,6 +15,17 @@
 
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 
+/**
+ * Directive to create a seealso admonition.
+ *
+ * Example:
+ *
+ * ```rest
+ *  .. seealso::
+ *
+ *      This is a seealso admonition.
+ * ```
+ */
 final class SeeAlsoDirective extends AbstractAdmonitionDirective
 {
     public function __construct(protected Rule $startingRule)

src/RestructuredText/Directives/TipDirective.php

@@ -15,6 +15,17 @@
 
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 
+/**
+ * Directive to create a tip admonition.
+ *
+ * Example:
+ *
+ * ```rest
+ *  .. tip::
+ *
+ *      This is a tip admonition.
+ * ```
+ */
 final class TipDirective extends AbstractAdmonitionDirective
 {
     public function __construct(protected Rule $startingRule)

src/RestructuredText/Directives/WarningDirective.php

@@ -15,6 +15,17 @@
 
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Rule;
 
+/**
+ * Directive to create a warning admonition.
+ *
+ * Example:
+ *
+ * ```rest
+ *  .. warning::
+ *
+ *      This is a warning admonition.
+ * ```
+ */
 final class WarningDirective extends AbstractAdmonitionDirective
 {
     public function __construct(protected Rule $startingRule)