Re: Doxygen for QML components

2012-10-17 Thread Daker Fernandes Pinheiro
2012/10/17 Marco Martin > On Wednesday 17 October 2012, Aurélien Gâteau wrote: > > An interesting bonus point of this annotation is that it could be used to > > provide more precise information about the type. For example a property > > which takes a QtObject but actually expects a model could be

Re: Doxygen for QML components

2012-10-17 Thread Sebastian Kügler
On Wednesday, October 17, 2012 16:09:51 Aurélien Gâteau wrote: > Are you OK with me following up with maintainers of api.kde.org so that > doxyqml is used to generate documentation there? +1 :) Thanks, -- sebas http://www.kde.org | http://vizZzion.org | GPG Key ID: 9119 0EF9 __

Re: Doxygen for QML components

2012-10-17 Thread Aleix Pol
On Wed, Oct 17, 2012 at 4:58 PM, Aurélien Gâteau wrote: > Le mercredi 17 octobre 2012 16:20:26 Aleix Pol a écrit : >> > The crude, done in 10 minutes one: >> > Define a custom comment to set on the property alias to document the type. >> > >> > Something like this: >> > property alias text: labe

Re: Doxygen for QML components

2012-10-17 Thread Aurélien Gâteau
Le mercredi 17 octobre 2012 16:20:26 Aleix Pol a écrit : > > The crude, done in 10 minutes one: > > Define a custom comment to set on the property alias to document the type. > > > > Something like this: > > property alias text: label.text // doxyqml: type=string > > > > I consider the second o

Re: Doxygen for QML components

2012-10-17 Thread Marco Martin
On Wednesday 17 October 2012, Aurélien Gâteau wrote: > An interesting bonus point of this annotation is that it could be used to > provide more precise information about the type. For example a property > which takes a QtObject but actually expects a model could be marked as > such: > > property

Re: Doxygen for QML components

2012-10-17 Thread Aleix Pol
On Wed, Oct 17, 2012 at 4:09 PM, Aurélien Gâteau wrote: > Le mardi 16 octobre 2012 21:39:15 Marco Martin a écrit : >> On Tuesday 16 October 2012, Aurélien Gâteau wrote: >> > - document class elements with comment blocks located next to the >> > documented element >> > >> > The code is available fr

Re: Doxygen for QML components

2012-10-17 Thread Aurélien Gâteau
Le mardi 16 octobre 2012 21:39:15 Marco Martin a écrit : > On Tuesday 16 October 2012, Aurélien Gâteau wrote: > > - document class elements with comment blocks located next to the > > documented element > > > > The code is available from kde:scratch/gateau/doxyqml . It is just a hack > > right now

Re: Doxygen for QML components

2012-10-16 Thread Marco Martin
On Tuesday 16 October 2012, Aurélien Gâteau wrote: > - document class elements with comment blocks located next to the > documented element > > The code is available from kde:scratch/gateau/doxyqml . It is just a hack > right now, using a proper grammar file would be more reliable, but it works >

Doxygen for QML components

2012-10-16 Thread Aurélien Gâteau
Hi, Currently documentation for QML components is done via a big comment at the beginning of the QML files, which leads to duplication of information and thus sometimes synchronization problems. For example right now the TabBar documentation states it inherits from DualStateButton. I have been