Re: The state of our API documentation and what to do about it

2024-08-20 Thread Nicolas Fella
On 20.08.24 13:44, David Redondo wrote: Am Montag, 19. August 2024, 22:07:13 MESZ schrieb Nicolas Fella: You can see it in action at https://nicolasfella.de/docs/kcoreaddons-module.html. There's still some minor things to be ironed out, but overall it looks promising to me. Could we leverage

Re: The state of our API documentation and what to do about it

2024-08-20 Thread Nicolas Fella
On 20.08.24 13:33, Ben Cooksley wrote: On Tue, Aug 20, 2024 at 8:07 AM Nicolas Fella wrote: On 09.07.24 18:37, Nicolas Fella wrote: > Hi, > > while reviewing our API documentation I noticed an increasing amount of > brokenness in it. Not even in the content, but the way

Re: Re: The state of our API documentation and what to do about it

2024-08-20 Thread David Redondo
Am Montag, 19. August 2024, 22:07:13 MESZ schrieb Nicolas Fella: > You can see it in action at > https://nicolasfella.de/docs/kcoreaddons-module.html. There's still some > minor things to be ironed out, but overall it looks promising to me. > Could we leverage this to provide docs for different

Re: The state of our API documentation and what to do about it

2024-08-20 Thread Ben Cooksley
On Tue, Aug 20, 2024 at 8:07 AM Nicolas Fella wrote: > On 09.07.24 18:37, Nicolas Fella wrote: > > Hi, > > > > while reviewing our API documentation I noticed an increasing amount of > > brokenness in it. Not even in the content, but the way it is presented. > > > > Doxygen seems to struggle to p

Re: The state of our API documentation and what to do about it

2024-08-19 Thread Nicolas Fella
On 09.07.24 18:37, Nicolas Fella wrote: Hi, while reviewing our API documentation I noticed an increasing amount of brokenness in it. Not even in the content, but the way it is presented. Doxygen seems to struggle to properly parse and document some new-ish Qt features: - It doesn't parse sign

Re: The state of our API documentation and what to do about it

2024-07-10 Thread Joshua Goins
> Hi, > > +1 in general. The documentation particularly for Kirigami and QML stuff > is quite sad. > > Does the switch to qdoc mean we have to write documentation in the _cpp_ > file, though? That would be unfortunate. > No, see his patch at the bottom of the e-mail. Hopefully that won't be the

Re: The state of our API documentation and what to do about it

2024-07-10 Thread Kai Uwe Broulik
Hi, +1 in general. The documentation particularly for Kirigami and QML stuff is quite sad. Does the switch to qdoc mean we have to write documentation in the _cpp_ file, though? That would be unfortunate. Cheers Kai Uwe

Re: The state of our API documentation and what to do about it

2024-07-09 Thread David Edmundson
> Thoughts on my proposal? +1000 Do you have a branch where you're testing this along with the qdoc patch? David

Re: The state of our API documentation and what to do about it

2024-07-09 Thread Ben Cooksley
On Wed, Jul 10, 2024 at 4:37 AM Nicolas Fella wrote: > Hi, > Hi Nicolas, > > while reviewing our API documentation I noticed an increasing amount of > brokenness in it. Not even in the content, but the way it is presented. > > Doxygen seems to struggle to properly parse and document some new-i

Re: The state of our API documentation and what to do about it

2024-07-09 Thread Christoph Grüninger
Hi Nicolas, I couldn't find according tickets in Doxygen's issue tracker. I looked for Q_SIGNAL, QML_ELEMENT, QML_NAMED_ELEMENT, and QML_SINGLETON. I know they have 1,7k open issues and it might not be their highest priority. I still would prefer to let Doxygen know what we as their users would

Re: The state of our API documentation and what to do about it

2024-07-09 Thread Albert Astals Cid
El dimarts, 9 de juliol del 2024, a les 18:37:16 (CEST), Nicolas Fella va escriure: > Hi, > > while reviewing our API documentation I noticed an increasing amount of > brokenness in it. Not even in the content, but the way it is presented. > > Doxygen seems to struggle to properly parse and docu