search

r7com / r7-component

TODO: a description
Do What The F*ck You Want To Public License
2 stars 2 forks source link

Create Docs #3

Open weslleyaraujo opened 9 years ago

rodrigomilfont commented 9 years ago

Help para os parametros do JsDoc https://developers.google.com/closure/compiler/docs/js-for-compiler

Closure Linter https://developers.google.com/closure/utilities/docs/linter_howto

rodrigomilfont commented 9 years ago

Um exemplo do JsDoc http://usejsdoc.org/tags-constructs.html

rodrigomilfont commented 9 years ago

Linha para o build ./node_modules/.bin/jsdoc -d documentation -r src/ && google-chrome documentation/index.html

guilhermepontes commented 9 years ago

Why don't you only use the README.md file to create a doc?

guilhermehn commented 9 years ago

Porque a intenção não é só documentar este componente, mas sim usar ele como modelo pra todos os próximos componentes que criaremos. Toda vez, para cada um, ter que abrir o readme, é imprático.

dpsxp commented 9 years ago

Da hora é que se pa nem precisa gerar a doc mesmo, só pelos coments a gente já consegue manjar.

guilhermepontes commented 9 years ago

hmmmm got it

dpsxp commented 9 years ago

galera acho que rola usar https://www.npmjs.com/package/jsdoc-to-markdown Markdown FTW!

rodrigomilfont commented 9 years ago

Exemplo de como ficaria com o jsdoc2md

https://github.com/r7com/r7-component/tree/issues/jsDoc/markdown#R7

2015-02-09 13:56 GMT-02:00 Daniel Paulino notifications@github.com:

galera acho que rola usar https://www.npmjs.com/package/jsdoc-to-markdown Markdown FTW!

— Reply to this email directly or view it on GitHub https://github.com/r7com/r7-component/issues/3#issuecomment-73532869.