This is the mail archive of the guile@cygnus.com mailing list for the guile project.
| Index Nav: | [Date Index] [Subject Index] [Author Index] [Thread Index] | |
|---|---|---|
| Message Nav: | [Date Prev] [Date Next] | [Thread Prev] [Thread Next] |
Andrew Archibald <aarchiba@calum.csclub.uwaterloo.ca> writes: > Maciej Stachowiak <mstachow@mit.edu> writes: > > <Things we neeed to do for a doc system> > > * Figure out pre-processor issues mentioned by Jim (Guile actually > > provides some primitives conditionally, so this is relevant). > > Perhaps guile should document those procedures even if they're not > used? I tend to think they should be there but return an error > (not-compiled-in, say), so people know what to expect from different > versions of guile. > > Alternate versions should definitely be both documented in the same > docstring; people may have to cope with both in different guile > interpreters. As I already pointed out, the preprocessor issues are easy to handle -- you can preprocess while preserving comments and not defining the macro SCM_PROC so that the cue to the doc extractor is still there. It may be useful to permit juxtaposed comments to be combined by the extraction systm (so that conditional compilation #ifdefs could be used to affect the documentation as well). Greg