On Wed, Aug 7, 2013 at 11:09 AM, Christopher Sean Morrison <[email protected]> wrote: > On Aug 07, 2013, at 08:09 AM, Tom Browder <[email protected]> wrote: ... > Also there is my > fairly-well-scrubbed list of current binary programs and their > matching source files (that I have found so far) that have no man > page. ... > How does your list compare with the list in the top-level TODO file? > (It's at the top of the DOCUMENTATION section.)
Much longer--and many on the old list no longer exist--I'll replace it. > Does initial imply that the long-term intent is to keep regenerating the > manual page from the sources or is this a one-shot bulk-creation event? Yes, I thought that was part of the auto-doc goal. > The README looks good, but I'd be concerned about the long-term implications > of having an implicit format to comments and introducing more globals (the > progression is to eliminate most). Well, the globals (only two) should be local to the file, but they could be moved inside main with a little clean up. Also, if we are happy with a man page it could always be removed from the auto-list. > a usage() function, which I believe some needed to avoid c90 string limits > aside from encapsulating usage to a single location. That can be handled I think if need be. > Our source comments are using Doxygen, so perhaps a standard form or even > some customized commands could help here? But if this is a one-shot deal, > it won't matter. I looked at Doxygen, but it really seems to be more oriented to functions, variables, etc. than main function inputs, and I think it would take a lot more effort to make that work--and my method is very similar. (I think the customized commands are really aliases for existing commands.) Best, -Tom ------------------------------------------------------------------------------ Get 100% visibility into Java/.NET code with AppDynamics Lite! It's a free troubleshooting tool designed for production. Get down to code-level detail for bottlenecks, with <2% overhead. Download for free and get started troubleshooting in minutes. http://pubads.g.doubleclick.net/gampad/clk?id=48897031&iu=/4140/ostg.clktrk _______________________________________________ BRL-CAD Developer mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/brlcad-devel
