>>> -WARN_IF_UNDOCUMENTED = YES >>> +WARN_IF_UNDOCUMENTED = NO
Fabien wrote: > I switched the undoc off because I believe all important files to > document are done. Also, we should now focus more on other warnings > and on the overall structure of the documentation. Maybe it's just me being picky after using lint, etc. for 25 years, but I always prefer to address, correct or silence the individual warnings rather than disable warnings completely. This has saved me a lot of grief in the past where the really important warning made the difference in solving a problem. So if you don't mind, I'd like to work in the background to clean up the remainder of the warnings. > In particular, > I'd like to get your opinion on the high number of html source > files generated by doxygen as for now. I have to admit that I hadn't thought this far ahead. > 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. Do we really need to save the generated files under svn? > 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. > > 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. > 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. > > 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. > But in the case we should not worry about this, we could neglect the > important amount of generated files. I have to confess that I usually bring up the copy from the FLTK site with the comments and don't usually look at my local copy. What I would suggest is that the generated html is made available via the document links on the site. The full document source would still be available in the tarballs/svn for serious developers who probably would have no problem with downloading and installing doxygen. For casual users, maybe we could look at generating a single file version (doxygen to LaTeX to pdf perhaps?) and to include in the tarball. D. _______________________________________________ fltk-dev mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-dev
