Documentation Checklist

Documentation Checklist

• Wrap contents in an IIFE.
• Ensure there is a linebreak before the close of the IIFE.
• Convert double-quotes to single-quotes.
• Ensure there is a single whitespace between function and (.
• Ensure documentation text does a hard-wrap at 100 columns.
• Document all events and add the @fires pragma to any methods that fire these events.
  • Ensure that events are declared with the full event name, i.e. @event enyo.Scroller#event:onScroll
• Add the @lends pragma between the opening ( and the opening { of the enyo.kind declaration.
• Add the @lends pargma before the opening { of the published properties block.
• Ensure that all mixins are documented via the @mixes pragma.
• Ensure that a subkind has its parent kind documented via the @extends pragma.
• Remove the in prefix on parameters where possible.
• Explicitly use the @method pragma for enyo.inherit methods.
• Run the JSDoc compiler (jsdoc -c docs/conf.json) when finished to ensure there are no errors.