[wp-trac] [WordPress Trac] #42901: All summary tags should be removed from existing JSDoc.

[WordPress Trac]

#42901: All summary tags should be removed from existing JSDoc.
-------------------------+-------------------------------------------------
 Reporter:  herregroen   |       Owner:  atimmer
     Type:  defect       |      Status:  closed
  (bug)                  |   Milestone:  5.0
 Priority:  normal       |     Version:
Component:  General      |  Resolution:  fixed
 Severity:  normal       |     Focuses:  javascript, docs, coding-standards
 Keywords:  has-patch    |
  commit                 |
-------------------------+-------------------------------------------------
Changes (by atimmer):

 * owner:   => atimmer
 * status:  new => closed
 * resolution:   => fixed


Comment:

 In [changeset:"42411"]:
 {{{
 #!CommitTicketReference repository="" revision="42411"
 Docs: Remove `@summary` tags from JSDoc.

 As decided in the JavaScript core chat. With a few reasons:

 * It is visually cleaner when reading the source.
 * This bring the JavaScript documentation closer to the PHP documentation.

 The only disadvantage is that the JSDoc parser doesn't split out the
 summary and the description in the new format. We've decided to solve this
 when building the JavaScript documentation parser.

 Props herregroen.
 Fixes #42901.
 }}}

--
Ticket URL: <https://core.trac.wordpress.org/ticket/42901#comment:4>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform