> I did already put some Doxygen comments and a Doxyfle into the current > 1.3 svn, including some text pages in .../documentation/*.dox, and all > documentation for Fl_Widget. Not perfect, but somewhat workable. Yes I did generate it last week and we can start from these, for now Fl_Widget,Fl_Preferences and Fl_Clock appear to be commented.
> The first issue I would like to get out of the way is the decission if > Doxygen comments go: I would opt for all comments to be added to the source and even inline functions and typedef, enums. inlined functions could be referenced with the \fn tag enums with the \enum tag, typedef with the \typedef tag and so on. The advantage is that everything is located at one place, while providing less deps trouble with the headers and permits most of the time to see the related code impl. for the functions where non trivial code is worth to be seen (non inlined most of the time) > Creating ranges of STR worked very well last time. I suggest that we > simply use a group of STRs, describing the help files that need their > contents copied over. If marked "active" and "done" correctly, we will > not have any duplicate work. I didn't understand this one could you give an example of procedure ? > Anyone who can make a list of files in the /documentation directory > and split them into STR's? I could do that, I checked there is about 300+ files to check and comment (headers and sources) while doing the job. While waiting for your merge (for which I quite agree it's wiser to wait for, before we add comments ;-)), I'll see what I can do to develop quickly a simple tool that automates as much as possible the first increment task (getting most of the class methods comments from html into the src files and also generating a comment file list for the unresolved comments, ready to be included in the proper format in the srcs but manually (like typedefs, enums, custom comments,...). This way a class could be commented in few minutes (most of the job would be made automatically, and the unresolved comments would not be lost as we would have a report with a doxygen-formatted comments to be checked for add/added manually. Fabien _______________________________________________ fltk-dev mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-dev
