[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
- Feature request: api docs, Reißner Ernst, 2022/02/04
- Re: Feature request: api docs, Gavin Smith, 2022/02/04
- AW: Feature request: api docs, Reißner Ernst, 2022/02/07
- Re: Feature request: api docs, Gavin Smith, 2022/02/11
- Re: Feature request: api docs, Ernst Reissner, 2022/02/12
- AW: Feature request: api docs, Reißner Ernst, 2022/02/14
- Re: Feature request: api docs, Gavin Smith, 2022/02/14
- AW: Feature request: api docs, Reißner Ernst, 2022/02/14
Re: Feature request: api docs, Patrice Dumas, 2022/02/04
- AW: Feature request: api docs, Reißner Ernst, 2022/02/07
- Re: Feature request: api docs, Patrice Dumas, 2022/02/19
- AW: Feature request: api docs, Reißner Ernst, 2022/02/22
- Re: AW: Feature request: api docs, Jacob Bachmeyer, 2022/02/23
- Re: AW: Feature request: api docs, Ernst Reissner, 2022/02/24
- Re: AW: Feature request: api docs, Jacob Bachmeyer, 2022/02/25
Re: Feature request: api docs, Gavin Smith, 2022/02/24