Greg and Duncan mentioned this before, and I had a first look into the 
php code that does it - I even tried a quick change, but this didn't 
work for several reasons.

There are some problems with the current approach: The docs with user 
comments (for 1.1) are generated by reading the html files and 
"embedding" them between a standard html header and footer and adding 
the user comments from the database. The comments in the database are 
linked by the document URL (if I understood this correctly).

Problem #1: The URL's of the doxygen comments may change from one 
generation run to the next, and especially from one version of doxygen 
to the next one (we found a big diff. between 1.5.7 and 1.5.9). This can 
result in loss of comments, or maybe also in "mixing" comments from one 
file with a new file that "inherited" the old URL (maybe).

Problem #2: Doxygen uses a sophisticated .css (cascading style sheet) 
file. The standard FLTK html header uses its own .css file. That's the 
reason why the FLTK 1.1 docs with and w/o comments look different, but 
with doxygen docs we would definitely need to use the doxygen .css file 
or a suitable combination.

Problem #3: Format differences, maybe be easy to solve.
(3a) lower case <body> and </body> instead of upper case.
(3b) very long lines (I found some > 1200 bytes) - the current php code 
reads with a 1024 bytes buffer, but this would probably not make a 
problem anyway (?).
(3c) we need to link to the non-frame version (that's trivial).

Questions:

Any ideas for problems #1 and #2 ?

When should we make the docs with comments available? Soon or only after 
  FLTK 1.3 stabilizes?

Would it be better to make the comments more version-specific, i.e. docs 
with comments for 1.3.0, 1.3.1, 1.3.2, ... or only for 1.3, 1.4, ...?

Albrecht
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev

Reply via email to