On 2005-03-23, Zachary Landau <[EMAIL PROTECTED]> wrote: > Am I on the right track? Is there any easier way? One case I haven't > gone into yet is adding guards. Also, sometimes the commented > descriptions of functions is too long to be a one-liner description. > > I'm wondering if a better approach is to have a rough tool for > identifying the different bindings, but then to manually edit the > results for correctness.
First of all, libextl-mkexports in libextl already does the parsing, and you could extend it with a simple output format that fits your needs, basically copying the current documentation output and replacing LaTeX with something else. With that you can find all functions meant to be used by the configuration editing user or the scripter. You will want to filter out some of them that aren't actions the basic user could be interested in. This inludes all marked with EXTL_SAFE. However, If you want simple concise documentation for the end user, I don't think the documentation in the source is the place to look for it. It is meant to be detailed enough to be useful for the scripter. I'd rather bootstrap the description files with the bdoc(...) docs in the current configuration files. It should be quite easy to write such a bootstrap script. You'll probably want to modify some of the descriptions that encompass multiple bindings to apply to only single description., just like switch_nth in your example. As I mentioned earlier, this description file might later became the source for geneating Ion manual pages as well, and the bdoc stuff be removed (replaced with normal comments). -- Tuomo
