Add a template for a class-description

Author: heiglandreas

Template.php

@@ -0,0 +1,56 @@
+<?php declare(strict_types=1);
+
+namespace Fig\Attributes;
+
+/**
+ * One-Line summary of what the attribute does
+ *
+ * Target audience
+ * ---------------
+ *
+ * Implementors:
+ *   Who should handle this attribute? Example: "static analysis tools"
+ * Users:
+ *   Who adds this attribute to their code? Example: "packages that want to
+ *   safeguard their functions via static analysis
+ *
+ * Long explanation of what the attribute does and why it is relevant.
+ *
+ * Use citations[1]_ or `Links <https://example.com>`_ in your text to make
+ * sure people understand the relevance and where you got your ideas from.
+ *
+ * If your Attribute has preconditions for usage you MUST use the keywords
+ * described in `RFC 2119 <https://datatracker.ietf.org/doc/html/rfc2119>`_.
+ * You SHOULD list them prominently.
+ *
+ * .. hint::
+ *    You can add Content-Blocks according to the `Sphinx ReST Cheatsheet`_
+ *
+ * .. important::
+ *    Feel free to use ReST **or** Markdown for this description.
+ *
+ * Please also use code-snippets where appropriate
+ *
+ * .. codeblock:: php
+ *     :linenos: true
+ *     :caption: A simple hello world
+ *
+ *     <?php
+ *     echo 'Hello World';
+ *
+ * You MUST describe parameters to your Attribute extensively!
+ * You can either use ReST or Annotations for that
+ *
+ * .. example::
+ *     :param $example_1: ``string`` does x and y
+ *     :param $example_2: ``boolean``
+ *
+ * .. example::
+ * @param string $example_1 Does x and y
+ * @param boolean $example_2
+ *
+ * .. [1] https://en.wikipedia.org/wiki/Citation
+ * .. _Sphinx ReST Cheatsheet: https://sphinx-tutorial.readthedocs.io/cheatsheet/
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final class Template {}