Closed ramya-rao-a closed 3 years ago
The current format of @property, @param and @returns tags where type information is added does not get rendered as needed
@property
@param
@returns
Example:
Since the source code in this package uses TypeScript and not JavaScript, we can simplify the docs as follows
@return
@constructor
memberof
@interface
@class
The current format of
@property
,@param
and@returns
tags where type information is added does not get rendered as neededExample:
Since the source code in this package uses TypeScript and not JavaScript, we can simplify the docs as follows
@returns
instead of@return
as per TSDoc@property
,@param
and@returns
tags@constructor
,memberof
,@interface
and@class
that are not needed in TS files