Fabien Costantini wrote: > I'd like to get your opinion on the high number of html source files > generated by doxygen as for now. > > I think it is time to think about how to release a maintainable doxygen doc > but IMHO, we have far too many html files to add to svn for now.
I don't think that they should be added to svn at all. Maybe we should release an extra FLTK-1.3-doc package / tar ball. FLTK 2 doesn't have them in the sources (svn), either. > One solution to reduce/limit that amount of files would be to remove the c++ > header source files generated, I'll vote +1 for that. I would like to keep the generated header files in the doxygen generated docs. But there are also some links that appear to point to .cxx source files that don't work, because these files don't exist. I can't give an example, however. > Also, I'm not satisfied with the prefixes generated for HTML files related to > classes, functions, enums and other aspects. > They are too long and I prefer the fltk2 documentation HTML files naming. They are the same (or at least similar) in FLTK 2. Look at dir documentation/html after running doxygen. > This said, it seems to me that the naming of HTML files changed in the 'new' > doxygen releases, older doxygen tools were not adding these ugly prefixes > AFAIR. Maybe, but we need to use current doxygen versions. > I believe we can't afford to let to the user the task of generating the > documentation, as he may not have doxygen, but I may be wrong. You're perfectly right. For the old (1.x) documentation you had to install Mike's htmldoc package to generate the pdf documentation file, but we had the complete handmade html documentation in the source tarball. For the new doxygen docs, I currently don't know how to generate a printable (pdf) version, although I know that there are doxygen options (GENERATE_LATEX and USE_PDFLATEX). I tried them once, but didn't succeed with my cygwin LaTeX version :-( > But in the case we should not worry about this, we could neglect the > important amount of generated files. > > Comments are welcome :-) What we should do IMHO: 1) Remove the old html doc files now (or shortly) to keep the documentation dir clean - remember: you can always check out the old docs from the saved branch or from an older release, or you can copy them *now* if you need them for reference, or you can access the online FLTK 1.1 version (that's really the same), or currently even the still online available FLTK 1.3 (old) html files. 2) Change the doxygen OUTPUT_DIRECTORY option to "." to generate the html docs in documentation/html (this is what FLTK 2 does, too). This would assure that the generated docs are created in the documentation tree. Then we could add svn:ignore for this dir file. 3) Change the Makefile (in the documentation dir) to accomodate the new docs. Maybe configure would have to find out, if doxygen is installed, and if not, this would be skipped. 4) Change the old fltk.pdf and fltk.ps targets to do the right thing, at least if the supporting software is installed (these have always been optional targets, you had to make them explicitly). 5) Generate the doxygen docs and also pdf (and maybe LaTeX) docs and make them available online (from time to time or with every new release). 6) make a new FLTK-1.3.x-doc package that includes the generated docs for those who want to have the docs offline available, but don't have doxygen - don't even download the sources (distribution packages for linux and others). Albrecht _______________________________________________ fltk-dev mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-dev
