>>>>> On Mon, 16 May 2022, Thomas Bracht Laumann Jespersen wrote:

>> +# @FUNCTION: qout
>> +# @DESCRIPTION:
>> +# qout <einfo | ewarn | eerror>  is a quiet call when EBUILD_PHASE
>> # should not have visible output.

> The devmanual says that @USAGE is also required for eclass functions
> [0]. This is applicable in a few cases, I'm just highlighting one
> here.

@USAGE is required if the function accepts any arguments. This is
similar to @RETURN, and is clear from the examples in [0]. For example,
jmake_src_compile at the bottom of the page doesn't have a @USAGE line.

> OTOH lots of eclass functions have left out @USAGE, and the tooling
> around html/man page generation also appears to treat it as optional.

Which is correct AFAICS.

> So it could be that the devmanual is wrong here.

> [0]: https://devmanual.gentoo.org/eclass-writing/index.html#eclass-functions

Attachment: signature.asc
Description: PGP signature

Reply via email to