diff options
| author |   Sam James <sam@gentoo.org> | 2021-03-22 06:44:06 +0000 |
|---|---|---|
| committer |   Ulrich Müller <ulm@gentoo.org> | 2021-03-30 08:53:26 +0200 |
| commit | b80285bdc37a51a2628bf4b7edd44717c15062cb (patch) | |
| tree | 1654f97a24b8cbc08bdd4658c2351a09a7b5ac42 | |
| parent | eclass-writing: add new eclass doc tags for Eclass Variables (diff) | |
| download | devmanual-b80285bdc37a51a2628bf4b7edd44717c15062cb.tar.gz devmanual-b80285bdc37a51a2628bf4b7edd44717c15062cb.tar.bz2 devmanual-b80285bdc37a51a2628bf4b7edd44717c15062cb.zip | |
eclass-writing: add new eclass doc tags for Eclass Functions
Adds:
* @INCLUDES_EPREFIX
* @DEPRECATED
Signed-off-by: Sam James <sam@gentoo.org>
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
| -rw-r--r-- | eclass-writing/text.xml | 23 |
1 files changed, 16 insertions, 7 deletions
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index b7fd988..5a1015f 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -508,21 +508,30 @@ documentation are: </ti> </tr> <tr> + <ti><c>@INCLUDES_EPREFIX</c></ti> + <ti>YES</ti> + <ti><d/></ti> <ti> - <c>@INTERNAL</c> - </ti> - <ti> - YES - </ti> - <ti> - <d/> + Indicates whether the function returns a path with ${EPREFIX} prepended + to it. </ti> +</tr> +<tr> + <ti><c>@INTERNAL</c></ti> + <ti>YES</ti> + <ti><d/></ti> <ti> Indicates that the function is internal to the eclass and should not be called from outside. </ti> </tr> <tr> + <ti><c>@DEPRECATED</c></ti> + <ti>YES</ti> + <ti>Optionally, the name of a replacement function.</ti> + <ti>Declares that this function should no longer be used in ebuilds.</ti> +</tr> +<tr> <ti> <c>@DESCRIPTION:</c> </ti> |