Skip to content

thgrendel/eslint-plugin-require-jsdoc

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

eslint-plugin-require-jsdoc

Original blurb by Ratheesh Naithalath This is a plugin for eslint for enforcing all FUNCTIONS should have jsdoc.
I had to write this because the (valid-jsdoc)(http://eslint.org/docs/rules/valid-jsdoc) rule in eslint did not help me to enforce that the functions MSUT have a jsdoc.Instead it validated the jsdoc. So for the best results use both together to make sure jsdoc is a must for all methods and they are valid.

##usage Follow the instructions here

eg:
(in your eslintrc)

  "plugins": [   
    "require-jsdoc"   
  ],
  "rules": {   
    "require-jsdoc": 2,  
    "valid-jsdoc": 2   
  }   

##future In future I hope to add jsdoc validation as well. Hence two rules can be avoided.
Please let me know your feedbacks.

##fork remove the requirement for return tag.

About

An eslint rule for jsdoc require - forked to remove check for @return.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%