[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, 14 Feb 2022 13:07:53 +0000 |
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
I think, if all is happy with that solution, we shall implement along the same
line, right?
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