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

Writing/generating documentation #8

Open
alexstrat opened this issue Oct 19, 2011 · 6 comments
Open

Writing/generating documentation #8

alexstrat opened this issue Oct 19, 2011 · 6 comments

Comments

@alexstrat
Copy link
Collaborator

Generate doc using dox.

in /docs folder

(http://dailyjs.com/2011/01/20/framework-part-47/)
(https://github.com/visionmedia/dox)

@alexstrat
Copy link
Collaborator Author

Interesting too and beauuutifull : https://github.com/jashkenas/docco

@jinroh
Copy link
Owner

jinroh commented Oct 19, 2011

Dans tout les cas c'est la même syntaxe utilisée ?

@alexstrat
Copy link
Collaborator Author

oui oui ! Apres peut être qu'il y'en a un qui reconnait pas tel ou tel tag... nan mais là où ça devient compliqué c'est lorsqu'il y a des histoires de classes et tout. Faut qu'on parle, et qu'on se mettent d'accord, mais bon c'est pas vital..

@alexstrat alexstrat reopened this Oct 19, 2011
alexstrat added a commit that referenced this issue Nov 15, 2011
@alexstrat
Copy link
Collaborator Author

Bon j'ai installer JsDoc3 (c'est du Rhino) avec le jake qui va bien..

Pour l'instant la doc c'est pas la folie, masi c'est prometteur.. Et t'as le droit au markdown !!

En plus il y'a de bonnes améliorations dans la version 3 qui pourront nous servir (@module par exemple). Pour l'instant c'est en beta et assez mal documenté mais on verra plus tard si le projet a avancé..

@jinroh
Copy link
Owner

jinroh commented Nov 15, 2011

Ca roule je regarde ca. Je vais regarder pour l'EventEmitter moi

@jinroh jinroh closed this as completed Nov 20, 2011
@jinroh jinroh reopened this Nov 20, 2011
@alexstrat
Copy link
Collaborator Author

Hope is here : doctor

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

No branches or pull requests

2 participants