Re: [fltk.development] Fluid supporting Doxygen (SVN 6291)
On 23.09.2008, at 10:08, Duncan Gibson wrote:
I've just experimented with the new, improved fluid and was able to
add the doxygen comments for these static member variables, and then
to generate the html with some test text (may be changed by the
user).
One comment: on my first attempt I typed in the full doxygen comment
with delimiters (i.e. /** may be changed by the user */ and of
course
fluid enclosed this within extra /** and */. So could you change the
tooltip to add (/** and */ will be added) or strip /** and */ from
the comment text if needed?
Yes, I can see that that is a problem.
Earlier this summer I experimented with adding doxygen comments using
the normal fluid comment feature, and found that the code generation
doesn't always output the comments in the places where doxygen
expects.
This new doxygen comment feature looks much more promising and is a
lot
less awkward to use than New {Class, Function, Declaration} followed
by
New Comment, and then a lot of F2/F3 to move it in front of where it
was needed.
Thanks. The original comment implmentation had no Doxygen in mind. It
was based on the request the add a copyright message at the top and
bottom of the .fl, .H, and .cxx file.
http://robowerk.com/
___
fltk-dev mailing list
fltk-dev@easysw.com
http://lists.easysw.com/mailman/listinfo/fltk-dev
Re: [fltk.development] Fluid supporting Doxygen (SVN 6291)
[...], so I decided to add Doxygen support as a feature. Check out
the current SVN. Opening the function, class, or declaration panel,
you will find a new field for comments. Just type something and it
will be placed (hopefully correctly) in the source or header file.
As a reminder, the first line is repeated in the browser.
The code is mostly untested, so please feel free to comment, and if
this feature is not liked, I'll be happy to reverse the patch :-)
I've been working through the doxygen warnings so that there are no
undocumented warnings that will hide real problems, and had just got
to Fl_File_Chooser. However, Fl_File_Chooser.[H,cxx] are generated
by fluid, so Fabien has added the doxygen comments to the additional
Fl_File_Chooser2.cxx file. There were warnings about various static
members (e.g add_favorites_label, add_files_label, etc) but try as I
might last night, I couldn't get doxygen to recognise more than one
of them at a time.
I've just experimented with the new, improved fluid and was able to
add the doxygen comments for these static member variables, and then
to generate the html with some test text (may be changed by the user).
One comment: on my first attempt I typed in the full doxygen comment
with delimiters (i.e. /** may be changed by the user */ and of course
fluid enclosed this within extra /** and */. So could you change the
tooltip to add (/** and */ will be added) or strip /** and */ from
the comment text if needed?
Earlier this summer I experimented with adding doxygen comments using
the normal fluid comment feature, and found that the code generation
doesn't always output the comments in the places where doxygen expects.
This new doxygen comment feature looks much more promising and is a lot
less awkward to use than New {Class, Function, Declaration} followed by
New Comment, and then a lot of F2/F3 to move it in front of where it
was needed.
Cheers
D,
___
fltk-dev mailing list
fltk-dev@easysw.com
http://lists.easysw.com/mailman/listinfo/fltk-dev
Re: [fltk.development] Fluid supporting Doxygen (SVN 6291)
I saw that there was an issue with Fluid-generated files requiring an extra .dox file. Well, there are two solultions to this. One can use the commant block and just type one (or more) Doxygen comments into that block. Just start the commant with /** and Fluid will recognize that and create a correct comment block. Yes, prepare the gun and the bullets, i capitulated for that one ... But this seemed inconvenient, so I decided to add Doxygen support as a feature. Check out the current SVN. Opening the function, class, or declaration panel, you will find a new field for comments. Just type something and it will be placed (hopefully correctly) in the source or header file. As a reminder, the first line is repeated in the browser. The code is mostly untested, so please feel free to comment, and if this feature is not liked, I'll be happy to reverse the patch :-) This is really cool matt! here's my 2 cents: The comment upper the api looks ugly and make hard to read the non comment strangely aligned code (due to the vertical shift). I tought about the tooltips and it could be great if you draw the comment with a tooltip I believe so that the tree remains intact,okay you see only one comment at a time but it could suffice quite well ... When you think about it, you indeed don't need to see the comments all the time so probably a view/hide switch would be nice as well. ___ fltk-dev mailing list fltk-dev@easysw.com http://lists.easysw.com/mailman/listinfo/fltk-dev
Re: [fltk.development] Fluid supporting Doxygen (SVN 6291)
I saw that there was an issue with Fluid-generated files requiring an extra .dox file. Well, there are two solultions to this. One can use the commant block and just type one (or more) Doxygen comments into that block. Just start the commant with /** and Fluid will recognize that and create a correct comment block. It's easier if you use /// at the start of each line in the comment dialog, *but* fluid might move the comment from before the next item, so you may need to be explicit with \class, \fn, etc tags. ___ fltk-dev mailing list fltk-dev@easysw.com http://lists.easysw.com/mailman/listinfo/fltk-dev
