WordPress.org

Make WordPress Core

Changes between Initial Version and Version 1 of Ticket #41682, comment 13


Ignore:
Timestamp:
08/24/2017 09:46:54 AM (3 years ago)
Author:
herregroen
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #41682, comment 13

    initial v1  
    1515
    1616* The comments I've removed were either incorrectly used `@global` tags ( these do not document a global being used, they document that the function/variable being documented is a global and thus override `@memberOf` statements ) or comments I felt added no additional information when the correct tags were added ( for example: `utility function namespace` to `@namespace wp.customize.utils` )
    17 * The parse errors are expected. The `@global` tags I've removed were not the only tags being incorrectly used and JSDoc throws errors for each incorrect usage. The official WordPress javascript documentation standards ( https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/ ) are not compatible with JSDoc and using them will result in errors. My suggestion here would be to change the javascript documentation standards to match the standards of JSDoc, but that's probably an issue for another ticket.
     17* The parse errors are expected. The `@global` tags I've removed were not the only tags being incorrectly used and JSDoc throws errors for each incorrect usage. The official WordPress javascript documentation standards ( https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/ ) contain some deviations from JSDoc and using them will result in errors. My suggestion here would be to change the javascript documentation standards to match the standards of JSDoc, but that's probably an issue for another ticket. There's also existing documentation that neither follows the JSDoc standards nor the WordPress standards.