GalSim-developers/GalSim — pull request #249 by rmandelb (2012-09-14 14:40:57+00:00)
Title: #182 - cleaning up the doxygen documentation

This pull request is for a cleanup of the documentation produced by doxygen so it doesn't contain so many private functions or those that users don't really need to know about. Along the way I found some old SBProfile codes that weren't being used, so I removed them (with the rationale that we can always go back and add them in later if we change our minds).

Here's a summary -

What got excluded: in Doxyfile, EXTRACT_PRIVATE and EXTRACT_LOCAL_CLASSES are set to NO

Files that were removed entirely from repo:
* Legendre.h - never used
* Pset, StringStuff - I suspect this functionality was used for SBParse, but we don't use it now, and given how we've been structuring the code, I don't think we'll ever need these.

Files that were removed from Dox but not from repo:
* in include/galsim/integ/: I removed everything but Int.h, since all we really care about are the int1d and int2d that live in Int.h, everything else is just helper functions
* Laguerre.h - which technically could go in the above category of "never used = delete", but since there have been discussions of using it for some things, I left it
* mmgr.h, Stopwatch.h - currently unused developer tools, probably worth keeping around for now but don't need to clutter the dox

.h files for which chunks with helper functions get removed from the dox:
integ/Int.h, FFT.h, ImageArith.h

I identified a few files for which the functions that get used need documentation: FFT.h (xTable, kTable), Table.h, Solve.h. I didn't attempt that, though-- if someone wants, they can do it on this pull request, otherwise I'll open a new issue after this is merged (for after the release, since I don't see this as critical).

Just a reminder, if you want to see the new/cleaned dox, you should blow away your existing ones in doc/html/ and doc/latex/. Otherwise the old versions will still be there and will include at least some of the stuff I tried to exclude.