[doc] To Embed Document in Wechaty Code for Generating Automaticly
Created by: huan
The Public API of Wechaty is almost not changed much during the past five months, but the module is increasing, and the internal API is changed a lot.
We need to document them better, not only the public but also the internal modules and methods.
So a document generator with embed document in code needs to be considering from now.
I'd like to prefer Dgeni, which is the Documentation Generator of AngularJS/Angular Material/Protractor/Ionic.
Here're some useful links:
https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentationhttp://allenhwkim.tumblr.com/post/92161523693/sigh-angularjs-documentation
Update on Feb 2017:
Finally we decided to use the classic jsdoc to embed document in TypeScript, then generate document to docs/ by jsdoc2md.