[wp-trac] [WordPress Trac] #64765: Incorrect @see tag syntax - WP_Recovery_Mode_Key_Service & WP_Recovery_Mode_Link_Service

[WordPress Trac]

#64765: Incorrect @see tag syntax - WP_Recovery_Mode_Key_Service &
WP_Recovery_Mode_Link_Service
--------------------------+-----------------------------
 Reporter:  marian1       |      Owner:  (none)
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  General       |    Version:
 Severity:  minor         |   Keywords:
  Focuses:  docs          |
--------------------------+-----------------------------
 Three `@param` descriptions in the Recovery Mode services reference
 methods without including the class name (`{@see function_name()}` instead
 of `{@see Class_Name::function_name()}`). In the generated Code Reference
 on developer.wordpress.org, these references are interpreted as functions
 and therefore
 [https://developer.wordpress.org/reference/functions/generate_recovery_mode_token
 resolve to 404 pages] instead of linking to the intended class methods.

 Affected:
  * `WP_Recovery_Mode_Key_Service::generate_and_store_recovery_mode_key()`
    * Parameter: `$token`
       * Incorrect: `{@see generate_recovery_mode_token()}`
       * Correct: `{@see
 WP_Recovery_Mode_Key_Service::generate_recovery_mode_token()}`
  * `WP_Recovery_Mode_Link_Service::get_recovery_mode_begin_url()`
    * Parameter: `$token`
       * Incorrect: `{@see generate_recovery_mode_token()}`
       * Correct: `{@see
 WP_Recovery_Mode_Key_Service::generate_recovery_mode_token()}`
    * Parameter: `$key`
       * Incorrect: `{@see generate_and_store_recovery_mode_key()}`
       * Correct: `{@see
 WP_Recovery_Mode_Key_Service::generate_and_store_recovery_mode_key()}`

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/64765>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform