ufukomer / node-impala

Node Client for Impala using Apache Thrift
https://www.npmjs.com/package/node-impala
MIT License
31 stars 12 forks source link

Port documentation to ESDoc #3

Closed harunurhan closed 3 years ago

harunurhan commented 8 years ago

Since ESDoc is one of the best options when it comes to generate documentation for ES6 codebase, I think it would be good to have proper documentation format that follows the rules of ESDoc (Syntax is almost same as JSDoc).

Also while porting, types for parameters should be added like described in tutorial.

ESDoc Tutorial