On Jul 20, 2013, at 5:27 PM, Tom Browder wrote: > While browsing the results of the integration of patch #53 (?), I said > this on the patch list about lib* man pages:
There is no list. I believe responding to a patch e-mail posts a comment to that patch. >> I have the first three files cleaned up I think rather nicely, but the >> last, for librt, is a mess. Apparently when it was originated librt >> had only a few variables and functions, but now the header is over >> 8,000 lines! Maintaining it manually (if it could be made current) >> would be a nightmare. I agree. Librt has grown to the point where we need to make serious efforts to break it up into separate libraries. One is already a pending patch (separation of libnmg) which is about a 1/3rd reduction. Another will be the core geometry including the core database I/O routines and the database objects (perhaps a "libg"). That will really help librt really just be about ray tracing. >> I know there are plans for a new doc system but I think we should look >> at one of several options for the lib* man pages (xml source) now. >> >> 1. Delete the current lib* docs. >> 2. If we want lib* docs, create a semi-auto-generated set consisting >> of several parts. Possibly something like: > ... >> + an auto-generated list of the headers associated with each lib (and >> maybe links to the man page for each header--which could be generated >> by Doxygen) Sounds like a good plan in addition to the Doxygen efforts. > Well, I just found that we have a dox/doygen target and gave it a try > and it looks good for a start. Is anyone working on it? I was actively working on the Doxygen files and probably the last to have been doing so, but I was really trying to focus on getting just one library in an ideal state so it could be an example for the others. I started with libbu and got maybe 80% there before I had to shift gears. > Maybe a limited Doxy output could generate the man pages for the libs? Absolutely. What the manual pages offer is the human-readable explanation of the API, which Doxygen has mechanisms for and which we utilize to a limited extent. If it can generate proper man pages, that'd be really awesome. Cheers! Sean ------------------------------------------------------------------------------ See everything from the browser to the database with AppDynamics Get end-to-end visibility with application monitoring from AppDynamics Isolate bottlenecks and diagnose root cause in seconds. Start your free trial of AppDynamics Pro today! http://pubads.g.doubleclick.net/gampad/clk?id=48808831&iu=/4140/ostg.clktrk _______________________________________________ BRL-CAD Developer mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/brlcad-devel
