bug-texinfo
[Top][All Lists]
Advanced

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

Feature request: api docs


From: Reißner Ernst
Subject: Feature request: api docs
Date: Fri, 4 Feb 2022 08:19:24 +0000

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

 


reply via email to

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