[wp-trac] [WordPress Trac] #30552: Inline Docs: Fix core DocBlock formatting and cross referencing
WordPress Trac
noreply at wordpress.org
Sun Nov 30 11:13:24 UTC 2014
#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 | Keywords:
Focuses: docs |
--------------------------+----------------------------
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.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/30552>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list