{"action":"created","issue":{"url":"https://api.github.com/repos/jscs-dev/jscs-jsdoc/issues/107","labels_url":"https://api.github.com/repos/jscs-dev/jscs-jsdoc/issues/107/labels{/name}","comments_url":"https://api.github.com/repos/jscs-dev/jscs-jsdoc/issues/107/comments","events_url":"https://api.github.com/repos/jscs-dev/jscs-jsdoc/issues/107/events","html_url":"https://github.com/jscs-dev/jscs-jsdoc/issues/107","id":82924689,"number":107,"title":"New Rule:  parameters require description","user":{"login":"dtracers","id":1933836,"avatar_url":"https://avatars.githubusercontent.com/u/1933836?v=3","gravatar_id":"","url":"https://api.github.com/users/dtracers","html_url":"https://github.com/dtracers","followers_url":"https://api.github.com/users/dtracers/followers","following_url":"https://api.github.com/users/dtracers/following{/other_user}","gists_url":"https://api.github.com/users/dtracers/gists{/gist_id}","starred_url":"https://api.github.com/users/dtracers/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dtracers/subscriptions","organizations_url":"https://api.github.com/users/dtracers/orgs","repos_url":"https://api.github.com/users/dtracers/repos","events_url":"https://api.github.com/users/dtracers/events{/privacy}","received_events_url":"https://api.github.com/users/dtracers/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2015-05-30T21:58:07Z","updated_at":"2015-05-31T01:03:56Z","closed_at":null,"body":"I would like a rule that says all parameters must require a description.\r\n\r\nThat way you can not just add a parameter but not describe what it is.\r\n\r\n(not sure how to implement this one though)"},"comment":{"url":"https://api.github.com/repos/jscs-dev/jscs-jsdoc/issues/comments/107104704","html_url":"https://github.com/jscs-dev/jscs-jsdoc/issues/107#issuecomment-107104704","issue_url":"https://api.github.com/repos/jscs-dev/jscs-jsdoc/issues/107","id":107104704,"user":{"login":"dtracers","id":1933836,"avatar_url":"https://avatars.githubusercontent.com/u/1933836?v=3","gravatar_id":"","url":"https://api.github.com/users/dtracers","html_url":"https://github.com/dtracers","followers_url":"https://api.github.com/users/dtracers/followers","following_url":"https://api.github.com/users/dtracers/following{/other_user}","gists_url":"https://api.github.com/users/dtracers/gists{/gist_id}","starred_url":"https://api.github.com/users/dtracers/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dtracers/subscriptions","organizations_url":"https://api.github.com/users/dtracers/orgs","repos_url":"https://api.github.com/users/dtracers/repos","events_url":"https://api.github.com/users/dtracers/events{/privacy}","received_events_url":"https://api.github.com/users/dtracers/received_events","type":"User","site_admin":false},"created_at":"2015-05-31T01:03:56Z","updated_at":"2015-05-31T01:03:56Z","body":"I was thinking it required at least a letter or digit after the name.\r\n\r\n```\r\n/**\r\n * @param {Type} name validDescription\r\n */\r\nfunction foo(name) {\r\n}\r\n```\r\n\r\nBut this throws an error.\r\n\r\n```\r\n/**\r\n * @param {Type} name\r\n */\r\nfunction foo(name) {\r\n}\r\n```\r\n\r\n\r\nAlso another way people write these (just to think about supporting)\r\n\r\n```\r\n/**\r\n * @param {Type} name\r\n *                     Description on the next line some number of spaces over.  Which looks nicer\r\n *                     For very large descriptions that typically do not fit on one line.\r\n * @param {Type} name2\r\n *                    This also makes it easier to tell when each description starts.\r\n */\r\nfunction foo(name, name2) {\r\n}\r\n```\r\n\r\n\r\nBut this second one would probably be a separate rule about all param descriptions must be on the next line"}}