[wp-trac] [WordPress Trac] #14953: Add inline documentation to MultiSite functions
WordPress Trac
wp-trac at lists.automattic.com
Thu Sep 30 09:31:30 UTC 2010
#14953: Add inline documentation to MultiSite functions
--------------------------+-------------------------------------------------
Reporter: scribu | Owner:
Type: defect (bug) | Status: new
Priority: normal | Milestone: 3.1
Component: Inline Docs | Version: 3.0
Severity: normal | Keywords: needs-patch
--------------------------+-------------------------------------------------
Comment(by hakre):
I suggest to put the wordpress version number to
[http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.since.pkg.html
@since] (Documentation), as @since documents when (at which version) an
element was first added to a package.
The file changed in r15675 have the following package phpdocs:
{{{
* @package WordPress
* @subpackage Multisite
}}}
The last commit did use the MU version number (prefixing it with MU) which
is needlessly inventing something new on top of PHPDoc and breaks with the
documentation standard and with the current doing everywhere else in the
project. Everywhere else is with a very few exceptions, a related case
where this is problematic is here: #14921.
As we do not need to do documentation work for the past of the MU fork
(the MU fork is as much as I know history), I suggest to change the @since
tags to {{{@since 3.0.0}}} to streamline them with the rest of the
codebase.
Let me know if you would like to have a patch.
--
Ticket URL: <http://core.trac.wordpress.org/ticket/14953#comment:13>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software
More information about the wp-trac
mailing list