[wp-trac] [WordPress Trac] #64524: Incorrect @see tag syntax - wp_enqueue_code_editor()

[WordPress Trac]

#64524: Incorrect @see tag syntax - wp_enqueue_code_editor()
--------------------------+-----------------------------
 Reporter:  marian1       |      Owner:  (none)
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  General       |    Version:
 Severity:  minor         |   Keywords:
  Focuses:  docs          |
--------------------------+-----------------------------
 The PHPDoc for `wp_enqueue_code_editor()` includes this see tag: `@see
 wp_get_code_editor_settings();`.
 The `@see` tag should reference the function signature (including
 parentheses for functions/methods) but should not include a trailing
 semicolon as it is not part of the referenced symbol. The trailing
 semicolon also violates WP inline documentation standards.

 ==== Impact

 - May cause issues with documentation parsers and static analysis tools
 that expect a symbol reference

 ==== Proposed Change

 Change the current tag
 `@see wp_get_code_editor_settings();`
 To:
 `@see wp_get_code_editor_settings()`

 ==== Notes
 - File location: `wp-includes/general-template.php`.
 - A search for `@see.*;` didn’t turn up any other instances of `@see`
 references ending with a semicolon in the code base.

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