Wechaty: JSDoc publishing problem: missed the Room class
The JSDoc from https://github.com/Chatie/wechaty/blob/master/src/user/room.ts#L422-L430 has not been published properly at https://chatie.io/wechaty/#Room+say
There might be other classes missed as well, which need to be invested & fixed.
bug
huan
>All comments
The Problem
If we use a @private to document a constructor of the class, then this class will not be documented by the JSDoc.
Like the following code:
The Solution
In order to keep the constructor out of the document, we need to use @hideconstructor.
huan
on 9 Nov 2019
👀1
❤1
👍1
Was this page helpful?
0 / 5 - 0 ratings
Related issues
mukaiu
路
4Comments
xmsz
路
4Comments
zmrbak
路
6Comments
huan
路
3Comments
lijiarui
路
7Comments
Most helpful comment
The Problem
If we use a
@privateto document a constructor of the class, then this class will not be documented by the JSDoc.Like the following code:
https://github.com/Chatie/wechaty/blob/df0aec498b3f7c4145082aff9403f27bd43ee4bd/src/user/room.ts#L270-L273
The Solution
In order to keep the constructor out of the document, we need to use
@hideconstructor.See: https://stackoverflow.com/a/52566418/1123955