[wp-trac] [WordPress Trac] #30552: Inline Docs: Fix core DocBlock formatting and cross referencing

[WordPress Trac]

#30552: Inline Docs: Fix core DocBlock formatting and cross referencing
--------------------------+-----------------------------
 Reporter:  DrewAPicture  |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  Future Release
Component:  General       |     Version:
 Severity:  normal        |  Resolution:
 Keywords:                |     Focuses:  docs
--------------------------+-----------------------------
Description changed by DrewAPicture:

Old description:

> Per the [https://make.wordpress.org/core/handbook/inline-documentation-
> standards/php-documentation-standards/#formatting-guidelines Formatting
> Guidelines] in the inline docs standards for PHP in the Core Contributor
> Handbook most parts of DocBlocks (excluding the Summary) support some
> limited markdown formatting and inline `@see` tags for cross-referencing
> other functions, hooks, classes, and methods.
>
> This will serve as a tracking ticket for commits related to formatting
> that DocBlock information. This formatting effort is specifically
> important now that we're leveraging the Code Reference for displaying the
> parsed core documentation.

New description:

 Per the [https://make.wordpress.org/core/handbook/inline-documentation-
 standards/php-documentation-standards/#formatting-guidelines Formatting
 Guidelines] in the inline docs standards for PHP in the Core Contributor
 Handbook most parts of DocBlocks (excluding the Summary) support some
 limited markdown formatting and inline `@see` tags for cross-referencing
 other functions, hooks, classes, and methods.

 See #30473 for fixes related to removing invalid formatting in DocBlocks.

 This will serve as a tracking ticket for commits related to formatting
 that DocBlock information. This formatting effort is specifically
 important now that we're leveraging the Code Reference for displaying the
 parsed core documentation.

--

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