Skip to content
This repository has been archived by the owner on Jan 22, 2021. It is now read-only.

Documentation #6

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Documentation #6

wants to merge 2 commits into from

Conversation

rstacruz
Copy link

@rstacruz rstacruz commented Aug 8, 2011

I took an initial pass at attempting to document the public classes.

You can see it here:
http://rstacruz.github.com/node_cassandra/

To generate documentation (npm install -g coffee-script and jsdoc-toolkit required):

$ cake doc:build

To make the documentation available as http://yukim.github.com/node_cassandra:

$ cake doc:deploy

@rstacruz
Copy link
Author

rstacruz commented Aug 8, 2011

By the way, I really don't know what documentation tool should be used. I just went with JSDoc-toolkit as that seems to be what's widely-available.

@rstacruz
Copy link
Author

rstacruz commented Aug 8, 2011

Also: you may want to update the README document about Cassandra 0.8.x.

@rstacruz
Copy link
Author

rstacruz commented Sep 8, 2011

@yukim, do you need a new maintainer for this project? :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant