[wp-hackers] Proposal for a function commenting convention

Jacob wordpress at santosj.name
Mon Oct 15 02:08:19 GMT 2007


Matt wrote:
> On 10/14/07, Jacob <wordpress at santosj.name> wrote:
>   
>> 2. Deprecated functions, globals can be handled with @deprecated tag.
>>
>>     
>
> @deprecated has the version it was deprecated in, right?
>
>   
I'm kind of waiting until I get more feedback before I make a trac 
ticket and start doing any more documentation.

The second try [1] has @deprecated since 2.1 for one global. It isn't 
required, but it should be used to allow others to know when the global 
or function stopped being used.

/**
 * @since 1.5
 * @deprecated since 2.1
 */

[1] http://www.santosj.name/wp-settings.phpdoc.2.diff

Jacob Santos


More information about the wp-hackers mailing list