[plt-scheme] documentation guidelines & tools

YC, did SchemeDoc work on your modules?

I ran it and it didn't produce anything. Maybe I configured it incorrectly?

On 6/8/07, YC <yinso.chen at gmail.com> wrote:
> Thanks to all whom replied so far.
>
> It seems that SchemeDoc should be usable with module files too (at least
> nothing I read seem to prohibit it), and the generated document looks pretty
> good, but doesn't seem compatible with with doc.txt.
>
> Scribble, on the other hand, still lives in the pre branch, so not sure if
> it's ready for prime time yet...
>
> I will try both and see which one works better for my needs.
>
> So no one pick up on the docstring question yet - does that mean no one
> likes docstring? ;)
>
> Thanks,
> yinso
>
>
> On 6/8/07, Noel Welsh <noelwelsh at gmail.com> wrote:
> >
> > I think the future belongs to Scribble, which I understand is being
> > used to document future versions of PLT Scheme.  I have yet to use it,
> > but Dave tells me it is easy to use.
> >
> > I'm about a gnats whisker away from make a macro ala:
> >
> > (define/doc name documentation value)
> >
> > [Actually it will probably all definition of contract as well, have a
> > shorter name, and support more forms, but you get the idea]
> >
> > N.
> >
> > On 6/8/07, Grant Rettke < grettke at acm.org> wrote:
> > > Schemedoc works for code that does not live in modules and runs on v370:
> > >
> > > http://www.cs.aau.dk/~normark/schemedoc/
> > _________________________________________________
> >   For list-related administrative tasks:
> >   http://list.cs.brown.edu/mailman/listinfo/plt-scheme
> >
>
>