[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Chicken-users] egg documentation
From: |
Mark Fredrickson |
Subject: |
Re: [Chicken-users] egg documentation |
Date: |
Tue, 12 Feb 2008 10:52:02 -0600 |
This idea dove tails with discussion last week of providing docstrings
for lambdas. Felix pointed out that there is a hook to capture lambda
documentation. Will this work for documenting eggs, which might also
have data types, parameters, other info?
Texi seems like a reasonable standard to me, FWIW.
Cheers,
-M
> I think the best alternative would be having svnwiki tags to markup
> chicken docs (which is possible).
>
> Something like:
>
> <procedure name="foo" args="bar baz" retval="string">
> <description>This is foo</description>
> </procedure>
>
> From a known format, we can convert the wiki documentation to whatever
> format we need and even have an interactive documentation system. The
> current problem with the wiki documentation is that we don't have
> semantic markup.
>
> Best wishes,
> Mario
>
>
>
>
> _______________________________________________
> Chicken-users mailing list
> address@hidden
> http://lists.nongnu.org/mailman/listinfo/chicken-users
>
- [Chicken-users] egg documentation, Graham Fawcett, 2008/02/12
- [Chicken-users] Comprehensive documentation rewrite, Tobia Conforto, 2008/02/12
- Re: [Chicken-users] Comprehensive documentation rewrite, Mario Domenech Goulart, 2008/02/12
- Re: [Chicken-users] Comprehensive documentation rewrite, Tobia Conforto, 2008/02/12
- Re: [Chicken-users] Comprehensive documentation rewrite, Mario Domenech Goulart, 2008/02/12
- Re: [Chicken-users] Comprehensive documentation rewrite, Mark Fredrickson, 2008/02/12
- Re: [Chicken-users] Comprehensive documentation rewrite, Graham Fawcett, 2008/02/12
- Re: [Chicken-users] Comprehensive documentation rewrite, Graham Fawcett, 2008/02/12