Re: Feature request: api docs

[Gavin Smith]

On Fri, Feb 04, 2022 at 08:19:24AM +0000, Reißner Ernst wrote:
> Hello all,
> I know that texinfo offers some commands to document a function which can be 
> used for various computing languages.
> One can document the signature: specify name of function, return variable and 
> input parameters.
> 
> What is missing in my opinion: a way to document the meaning of the input 
> parameters
> And of the return value and documentation of errors/exception.
> There are many api doc systems providing these things, java, c#, 
> c++(doxygen), python(https://developer.lsst.io/python/numpydoc.html)
> And the latter is a good illustration for what I want to say.
> 
> Also missing: a way to document a class or even a package.
> Texinfo seems not yet arrived in oo world.
> 
> Any change to get this included?
> 
> I ask because texinfo has many advantages also... above all the many 
> interesting output formats.
> 
> Best Regards,
> Ernst
> 

Just so you know there was a program to use Texinfo in source code comments:

https://josefsson.org/gdoc/

I don't know anything about it otherwise, whether it would be enough for your
needs or whether it could be completely ignored and something new would need
to be developed.