commit: b691f696abfbc33a4e3f3bea2100ebc466c24e6b
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Thu Sep 2 07:54:21 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sat Sep 4 10:35:13 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b691f696
eclass-writing: More documentation tags
@SUBSECTION, @SUPPORTED_EAPIS, @PROVIDES, and @DEPRECATED.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
eclass-writing/text.xml | 30 ++++++++++++++++++++++++++----
1 file 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>
@@ -232,6 +233,21 @@ summarizes the available documentation tags:
<ti>A URI string</ti>
<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>
@@ -241,6 +257,12 @@ summarizes the available documentation tags:
line with the tag.
</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>
