jscs-jsdoc icon indicating copy to clipboard operation
jscs-jsdoc copied to clipboard

Add apiDoc tags support

Open qfox opened this issue 10 years ago • 3 comments

https://github.com/apidoc/apidoc/

Blocked by #69

qfox avatar Jan 22 '15 22:01 qfox

:+1: Any updates on this?

manikandants avatar Nov 23 '15 10:11 manikandants

The idea was to add a preset with all apiDoc tags. But it's useless until there is no multipreset support. #69

Atm you can do it manually (see http://jscs.info/rule/jsDoc#checkAnnotations):

{ "preset": "jsduck5",
  "extra": {
    "api": "some",
    "apiName": "some",
    "apiGroup": "some",
    "apiParam": "some",
    "apiSuccess": "some"
  } }

qfox avatar Nov 23 '15 14:11 qfox

Thanks @zxqfox :+1: As you mentioned, solved it manually :smiley:

"jsDoc" : {
        "checkAnnotations": {
            "preset": "jsduck5",
            "extra": {
                "api": "some",
                "apiName": "some",
                "apiGroup": "some",
                "apiParam": "some",
                "apiSuccess": "some",
                "apiVersion": "some",
                "apiDescription": "some"
            }
        }
    }

manikandants avatar Nov 24 '15 05:11 manikandants