diff options
| author |   Ulrich Müller <ulm@gentoo.org> | 2021-09-02 09:54:21 +0200 |
|---|---|---|
| committer | Ulrich Müller <ulm@gentoo.org> | 2021-09-04 12:35:13 +0200 |
| commit | b691f696abfbc33a4e3f3bea2100ebc466c24e6b (patch) | |
| tree | 7c540a8886408d844ec8e97a7387726c8ef12d70 /eclass-writing | |
| parent | eclass-writing: Whitespace (diff) | |
| download | devmanual-b691f696abfbc33a4e3f3bea2100ebc466c24e6b.tar.gz devmanual-b691f696abfbc33a4e3f3bea2100ebc466c24e6b.tar.bz2 devmanual-b691f696abfbc33a4e3f3bea2100ebc466c24e6b.zip | |
eclass-writing: More documentation tags
@SUBSECTION, @SUPPORTED_EAPIS, @PROVIDES, and @DEPRECATED.
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
Diffstat (limited to 'eclass-writing')
| -rw-r--r-- | eclass-writing/text.xml | 30 |
1 files changed, 26 insertions, 4 deletions
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 0c81bf6..791a2ce 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -151,10 +151,11 @@ each block documents an individual element of an eclass. <p> Documentation tags for various eclass elements are explained in their -respective sections below. Common to all the tags that accept -multiline freetext, the <c>@CODE</c> tag should be used when necessary -to create unformatted code chunks (such as example code) by placing -the tag at the beginning and the end. +respective sections below. Common to all the tags that accept multiline +freetext, the <c>@CODE</c> tag should be used when necessary to create +unformatted code chunks (such as example code) by placing the tag at the +beginning and the end. The <c>@SUBSECTION</c> tag inserts a subsection +heading; it is allowed only in the main <c>@DESCRIPTION</c>. </p> <p> @@ -233,6 +234,21 @@ summarizes the available documentation tags: <ti>Points to the URL of the VCS that contains the eclass source</ti> </tr> <tr> + <ti nowrap="nowrap"><c>@SUPPORTED_EAPIS:</c></ti> + <ti>YES</ti> + <ti>Space-separated list of EAPIs</ti> + <ti>List of EAPIs supported by this eclass</ti> +</tr> +<tr> + <ti><c>@PROVIDES:</c></ti> + <ti>YES</ti> + <ti>Space-separated list of eclass names</ti> + <ti> + List of indirectly inherited eclasses whose functions and variables may be + used by an ebuild inheriting this eclass + </ti> +</tr> +<tr> <ti><c>@BLURB:</c></ti> <ti>NO</ti> <ti>Single line freetext</ti> @@ -242,6 +258,12 @@ summarizes the available documentation tags: </ti> </tr> <tr> + <ti><c>@DEPRECATED:</c></ti> + <ti>YES</ti> + <ti>Replacement (or "none")</ti> + <ti>Declares that this eclass should no longer be used</ti> +</tr> +<tr> <ti><c>@DESCRIPTION:</c></ti> <ti>YES</ti> <ti>Multiline freetext</ti> |