[wp-trac] [WordPress Trac] #42675: Add documentation for heartbeat.js

[WordPress Trac]

#42675: Add documentation for heartbeat.js
-------------------------+-------------------------------
 Reporter:  andizer      |       Owner:  adamsilverstein
     Type:  enhancement  |      Status:  closed
 Priority:  normal       |   Milestone:  5.0
Component:  General      |     Version:  trunk
 Severity:  normal       |  Resolution:  fixed
 Keywords:               |     Focuses:  javascript, docs
-------------------------+-------------------------------
Changes (by atimmer):

 * status:  assigned => closed
 * resolution:   => fixed


Comment:

 In [changeset:"42389"]:
 {{{
 #!CommitTicketReference repository="" revision="42389"
 Docs: Improve JS Docs for `wp-includes/js/heartbeat.js`.

 Most of the documentation was already present. This change achieves the
 following:

 * Fixes the formatting for most doc blocks.
 * Adds `@since` tags to all functions.
 * Makes sure the heartbeat public methods are correctly added to the
 `wp.heartbeat` namespace.

 Props andizer, jjcomack, carolinegeven.
 Fixes #42675.
 }}}

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