Title here
Summary here
dana/class-jsdoc
This rule checks if class have jsdoc and if tags are correct. It checks tags:
@name@extends@property
Incorrect
/**
* Some description for ErroredClass
* @name WrongName
* @class
* @extends WrongExtend
*/
export default $WtvObject.declare("ErroredClass", {});/**
* Some description for ErroredClass
* @name WtvClass
* @extends WtvObject
*
* @property {string} someWrongPropertyName
*/
export default $WtvObject.declare("WtvClass", {
properties: {
someProperty: 'someValue'
}
});// no jsdoc
export default $WtvObject.declare("ErroredClass", {
properties: {
someProperty: 'someValue'
}
});/**
* Some description for ErroredClass
* @name WtvClass
* @extends WtvObject
*
* @property {string} somePropertyNotDeclared
*/
export default $WtvObject.declare("WtvClass", {});Correct
/**
* Some description for ClassName
* @name ClassName
* @class
* @extends WtvObject
*
* @property {string} someProperty
*/
export default $WtvObject.declare("ClassName", {
properties: {
someProperty: 'someValue'
}
});