fix some docs

README.md

@@ -47,7 +47,7 @@ Wechaty.instance() // Global Instance
 .start()
 ```
 
-> **Notice: Wechaty requires Node.js version >= 8.5**
+> **Notice: Wechaty requires Node.js version >= 10**
 
 This bot can log all messages to the console.
 
@@ -56,12 +56,11 @@ You can find more examples from [Wiki](https://github.com/chatie/wechaty/wiki/Ex
 ## GETTING STARTED
 
 [![node](https://img.shields.io/node/v/wechaty.svg?maxAge=604800)](https://nodejs.org/)
-[![Repo Size](https://reposs.herokuapp.com/?path=Chatie/wechaty)](https://github.com/chatie/wechaty)
 
 ### A Great Live Coding Tutorial
 
 <div align="center">
-<a target="_blank" href="https://blog.chatie.io/guide/2017/01/01/getting-started-wechaty.html"><img src="http://blog.chatie.io/download/2017/lijiarui-wechaty-quick-start-guide-video.jpg" border=0 width="60%"></a>
+<a target="_blank" href="https://blog.chatie.io/getting-started-wechaty/"><img src="http://blog.chatie.io/download/2017/lijiarui-wechaty-quick-start-guide-video.jpg" border=0 width="60%"></a>
 </div>
 
 The above 15 minute video tutorial is a good start point if you are new to Wechaty.

scripts/generate-docs.sh

@@ -3,7 +3,7 @@ set -e
 
 npm version
 
-if ./scripts/development-release.ts; then
+if [ "$1" != "dev" ] && ./scripts/development-release.ts; then
   echo "Current release is a development release, please only update the docs when there's a stable release."
   exit 1
 else

src/accessory.ts

@@ -30,6 +30,9 @@ export abstract class Accessory extends EventEmitter {
   private static _puppet?  : Puppet
   private static _wechaty? : Wechaty
 
+  /**
+   * @private
+   */
   public static set puppet(puppet: Puppet) {
     log.silly('Accessory', '<%s> static set puppet = "%s"',
                                   this.name,
@@ -42,6 +45,9 @@ export abstract class Accessory extends EventEmitter {
     this._puppet = puppet
   }
 
+  /**
+   * @private
+   */
   public static get puppet(): Puppet {
     // log.silly('Accessory', '<%s> static get puppet()',
     //                               this.name,
@@ -56,6 +62,9 @@ export abstract class Accessory extends EventEmitter {
                     )
   }
 
+  /**
+   * @private
+   */
   public static set wechaty(wechaty: Wechaty) {
     log.silly('Accessory', '<%s> static set wechaty = "%s"',
                                   this.name,
@@ -67,6 +76,9 @@ export abstract class Accessory extends EventEmitter {
     this._wechaty = wechaty
   }
 
+  /**
+   * @private
+   */
   public static get wechaty(): Wechaty {
     // log.silly('Accessory', '<%s> static get wechaty()',
     //                               this.name,
@@ -90,6 +102,9 @@ export abstract class Accessory extends EventEmitter {
    */
   private _puppet?  : Puppet
 
+  /**
+   * @private
+   */
   public set puppet(puppet: Puppet) {
     log.silly('Accessory', '<%s> set puppet = "%s"',
                                   this[SYMBOL_NAME] || this,
@@ -102,6 +117,8 @@ export abstract class Accessory extends EventEmitter {
   }
 
   /**
+   * @private
+   *
    * instance.puppet
    *
    * Needs to support different `puppet` between instances.
@@ -130,6 +147,8 @@ export abstract class Accessory extends EventEmitter {
   }
 
   /**
+   * @private
+   *
    * instance.wechaty is for:
    *  Contact.wechaty
    *  FriendRequest.wechaty

src/user/room.ts

@@ -221,7 +221,7 @@ export class Room extends Accessory implements Sayable {
   }
 
   /**
-   *
+   * @private
    *
    * Instance Properties
    *
@@ -792,6 +792,7 @@ export class Room extends Accessory implements Sayable {
 
   /**
    * Force reload data for Room
+   * @private
    * @deprecated use sync() instead
    * @returns {Promise<void>}
    */

src/wechaty.ts

@@ -136,14 +136,33 @@ export class Wechaty extends Accessory implements Sayable {
    */
   public readonly id : string
 
+  /**
+   * @private
+   */
   // tslint:disable-next-line:variable-name
   public readonly Contact       : typeof Contact
+
+  /**
+   * @private
+   */
   // tslint:disable-next-line:variable-name
   public readonly ContactSelf   : typeof ContactSelf
+
+  /**
+   * @private
+   */
   // tslint:disable-next-line:variable-name
   public readonly Friendship    : typeof Friendship
+
+  /**
+   * @private
+   */
   // tslint:disable-next-line:variable-name
   public readonly Message       : typeof Message
+
+  /**
+   * @private
+   */
   // tslint:disable-next-line:variable-name
   public readonly Room          : typeof Room
 
@@ -491,6 +510,8 @@ export class Wechaty extends Accessory implements Sayable {
   }
 
   /**
+   * @private
+   *
    * Init the Puppet
    */
   private initPuppetResolver(puppet?: PuppetName | Puppet): Puppet {
@@ -523,6 +544,8 @@ export class Wechaty extends Accessory implements Sayable {
   }
 
   /**
+   * @private
+   *
    * Plugin Version Range Check
    */
   private initPuppetSemverSatisfy(versionRange: string) {
@@ -719,6 +742,7 @@ export class Wechaty extends Accessory implements Sayable {
   }
 
   /**
+   * @private
    * @deprecated use start() instead
    */
   public async init(): Promise<void> {