Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add jscs's JSDocs plugin #27

Open
felquis opened this issue Jun 24, 2015 · 1 comment
Open

Add jscs's JSDocs plugin #27

felquis opened this issue Jun 24, 2015 · 1 comment

Comments

@felquis
Copy link
Member

felquis commented Jun 24, 2015

Should run with gulp style-guide, package's homepage

@felquis felquis added this to the 1.0.0-beta.1 milestone Jun 24, 2015
felquis added a commit that referenced this issue Jul 3, 2015
@felquis
Copy link
Member Author

felquis commented Jul 3, 2015

I used these rules

"jsDoc": {
    "checkParamNames": true,
    "requireParamTypes": true,
    "checkRedundantParams": true,
    "checkRedundantReturns": true,
    "requireReturnTypes": true,
    "requireParamDescription": true,
    "requireHyphenBeforeDescription": true,
    "disallowNewlineAfterDescription": true,
    "requireDescriptionCompleteSentence": true,
    "enforceExistence": "exceptExports"
}

@giorgiofellipe what do you think about the result?

felquis added a commit that referenced this issue Jul 4, 2015
felquis added a commit that referenced this issue Jul 4, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant