Re: Feature request: api docs

[Ernst Reissner]

On 2/11/22 12:40, Gavin Smith wrote:
> On Mon, Feb 7, 2022 at 8:19 AM Reißner Ernst <Ernst.Reissner@corpuls.com> wrote:
> > @Gavin Smith : the style I know is putting api docs with the code.
> > This turned out to be by far safest to keep docs up to date.
> > In java world, in c#, in c and c++ I think this is the accepted way to do it.
> > Also in lisp and in python...
> > I would wonder if also qt api docs wouldn’t be done that way.
> That is almost certainly the case. Compare
>
> https://code.qt.io/cgit/qt/qtbase.git/tree/src/widgets/widgets/qabstractslider.cpp
>
> and
>
> https://doc.qt.io/qt-5/qabstractslider.html.
>
> The QDoc manual: https://doc.qt.io/qt-5/01-qdoc-manual.html
>
> There are also other files used for other material, which doesn't come
> from source code files.
>
> https://doc.qt.io/qt-5/13-qdoc-commands-topics.html#page-command
>
> .

Hi Gavin,

Thats also true and would be a *very* desirable addon.

By the way, what do you think of my suggestion

to add to texinfo the tags @param, @return and @throws?

Of course, linking to other functions and to external material would be 
very useful.

I would like to suggest to my company, at least department, to use 
texinfo if we come to a good solution.

Matlab does not offer a lot of documentation features out of the box.