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]

Re: generating a manual from annotations in source code


Another positive aspect to documentation as comments in the source
code, is that a fairly complete reference manual generated this way
may make it easier to write the more structured parts of the
manual(s). Such a reference manual may motivate more people to
contribute to tutorial, and overview sections, etc.

This of course assumes that comments in the source code will get a
complete reference manal more quickly. Regardless, I think it is
helpful to get the reference manual complete and correct, so others
can more easily contribute to the structured manual.

					cheers,
					glenn.