bug-texinfo
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

AW: Feature request: api docs


From: Reißner Ernst
Subject: AW: Feature request: api docs
Date: Mon, 7 Feb 2022 08:37:15 +0000

I must correct myself: @result and @error are not usable, 
Because it has also semantics and within apidocs this would be misuse. 
I think @param, @return and @throws would be fine at least for functions. 
The above shall be to describe sth, like so: 
@return the return value is the @var{n} th prime number @end return
@param someparamname is the list of names in the database @end param
@throws totaldesasterexception in case of a total disaster @end throws 
Ernst



reply via email to

[Prev in Thread] Current Thread [Next in Thread]