Community
Participate
Working Groups
We should create an eslint rule that will check for missing doc tags in the following cases: 1. there is a parameter that is not doc'c with an @param tag 2. the function has a return statement but is missing an @returns tag 3. the function throws an exception (throw statement in the function) but does not have an @throws tag 4. missing @description tag optional tag checks could be: 1. missing @memberof 2. missing visibility - @public / @private 3. missing @name Ideally these checks would directly follow whatever we decide is the 'Orion way' to doc things.
(In reply to Michael Rennie from comment #0) > We should create an eslint rule that will check for missing doc tags in the > following cases: > > 1. there is a parameter that is not doc'c with an @param tag > 2. the function has a return statement but is missing an @returns tag > 3. the function throws an exception (throw statement in the function) but > does not have an @throws tag > 4. missing @description tag > > optional tag checks could be: > > 1. missing @memberof > 2. missing visibility - @public / @private > 3. missing @name > > > Ideally these checks would directly follow whatever we decide is the 'Orion > way' to doc things. Along with checking the tags we will have to check that the comment (if one exists) is a block comment since missing tag checking implies you are using JSDoc-style comments.
Closing as part of a mass clean up of inactive bugs. Please reopen if this problem still occurs or is relevant to you. For more details see: https://dev.eclipse.org/mhonarc/lists/orion-dev/msg03444.html
Reopening
The valid-jsdoc rule would cover this as well (bug 420083). Marking as a dupe. *** This bug has been marked as a duplicate of bug 420083 ***
