diff --git a/README.md b/README.md index 2eb60a5a8486c2496c8e46c43ca0e3b1191c5629..a11338133d2b48be0e64584deea7cf42819fbfa7 100644 --- a/README.md +++ b/README.md @@ -238,8 +238,13 @@ Scan now, then you can chat with other Wechaty developers! (secret code: _wechat - http://blog.thoughtram.io/angular/2016/01/06/taking-advantage-of-observables-in-angular2.html * [ ] [Generating Documentation for TypeScript Projects](https://blog.cloudflare.com/generating-documentation-for-typescript-projects/) +Documentation +------------- + +In order to sync the doc with the lastest code for best, Wechaty use [jsdoc](http://usejsdoc.org/) to descript API, and use [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown/wiki) to generate markdown format document to [docs](docs/) directory. + My Story ----------------- +-------- My daily life/work depends on too much chat on wechat. * I almost have 14,000 wechat friends in May 2014, before wechat restricts a total number of friends to 5,000. * I almost have 400 wechat rooms that most of them have more than 400 members. @@ -251,7 +256,7 @@ So a tireless bot working for me 24x7 on wechat, monitoring/filtering the most i At last, It's built for my personal study purpose of Automatically Testing. Author ------------------ +------ Zhuohuan LI (http://linkedin.com/in/zixia) diff --git a/src/wechaty.ts b/src/wechaty.ts index c8e16af94f49baac6e7c6cb0373a1f49be438e8d..bdc79a5b44804a7e784f08313bf828eea4196e89 100644 --- a/src/wechaty.ts +++ b/src/wechaty.ts @@ -159,6 +159,7 @@ export class Wechaty extends EventEmitter implements Sayable { /** * @todo document me + * @returns {Contact} */ public user(): Contact { if (!this.puppet || !this.puppet.user) {