search

jinroh / kadoh

The Kademlia DHT in Javascript for Node.js and Browsers
http://jinroh.github.com/kadoh
Other
242 stars 31 forks source link

Writing/generating documentation #8

Open alexstrat opened 12 years ago

alexstrat commented 12 years ago

Generate doc using dox.

in /docs folder

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

alexstrat commented 12 years ago

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

jinroh commented 12 years ago

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

alexstrat commented 12 years ago

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 commented 12 years ago

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 commented 12 years ago

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

alexstrat commented 12 years ago

Hope is here : doctor