Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JSDoc - Documenation generator #41

Open
booo opened this issue May 20, 2011 · 4 comments
Open

JSDoc - Documenation generator #41

booo opened this issue May 20, 2011 · 4 comments
Assignees
Milestone

Comments

@booo
Copy link
Member

booo commented May 20, 2011

We agreed to use JSDoc as documentation standard. We need a documentation generator like https://github.com/visionmedia/dox We need a place for the documenation on the server.

Should we generate the api documentation on every commit?

@AlexanderS
Copy link
Member

I think, that the documentation should be generated after all test succeeded. Maybe jankins could provide storage for the doc as build artifacts?

@ghost ghost assigned sladda Jun 6, 2011
@sladda
Copy link

sladda commented Jun 6, 2011

wie sind die genauen Anforderungen an den Generator ?

@booo
Copy link
Member Author

booo commented Jun 6, 2011

There should be an overview of the different modules and for every module the documentation. If the process is complex there should be a script for everything. We should introduce a new directory for the api documentation.

@mren
Copy link

mren commented Jun 7, 2011

we can use github to host the documentation

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

No branches or pull requests

4 participants