This is the mail archive of the guile@sourceware.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: Doc Tasks (was RE: docstrings in Guile!)


Per Bothner <per@bothner.com> writes:

> As another data-point, people might want to take a look at Java's
> "javadoc" system.  You basically add special comments in the source.
> These are extracted by the javadoc program, which generates quite
> decent on-line documentations.  (For example see
> http://www.javasoft.com/products/jdk/1.2/docs/api/overview-summary.html
> or http://sourceware.cygnus.com/kawa/api/ .)
> 
> The special comments are delimited by /** .... */.  They must be special
> places in the source code, before the start of the function (or other
> definition) they document.  Certain special tags have special meaning.
> For example @param documents a parameter and @return documents the result.
> In addition, the comments can contain arbitrary html.
> 
> See http://java.sun.com/products/jdk/javadoc/ for more information.

JavaDoc was a big influence in my design of Scwm's system -- we use the
same /** intro token, and permit arbitrary SGML DocBook markup inside
the sections.

Greg

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]