[narwhal] Documentation

3 views
Skip to first unread message

Kris Kowal

unread,
May 23, 2010, 6:24:16 AM5/23/10
to narw...@googlegroups.com
First cut of documentation from my "future" branch, using "whatsupdoc"
and "thatsallfolks":

http://kriskowal.github.com/narwhal/api/packages---narwhal-lib.html

I could use a lot of help filling out details. If you're up for a
challenge, "whatsupdoc" could use some love in the tagParsers to be
more comprehensive, and any help converging with complete or nearly
complete compatibility with jsdoc format would be helpful. There are
some variations in my @grammar. I also need to do something about
cross-references in doc markdown.

Getting "wudoc" to run at home requires:

* ry/node/v0.1.95
* kriskowal/narwhal/v0.5.0 (future)
* kriskowal/narwhal-node/v0.0.2
* kriskowal/thatsallfolks/v0.0.1
* kriskowal/whatsupdoc/v0.0.1

Then the "wudoc" command will do the trick. Since I'm working in both
"master" and "future", I keep separate seas.

Kris Kowal

--
You received this message because you are subscribed to the Google Groups "Narwhal and Jack" group.
To post to this group, send email to narw...@googlegroups.com.
To unsubscribe from this group, send email to narwhaljs+...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/narwhaljs?hl=en.

Christoph Dorn

unread,
May 23, 2010, 12:09:23 PM5/23/10
to narw...@googlegroups.com

Looking great!

Christoph
Reply all
Reply to author
Forward
0 new messages