[wp-hackers] Plugin Standard Suggestion for PHPdoc Inline
Documentation
Stephane Daury
wordpress at tekartist.org
Tue Jul 8 03:46:33 GMT 2008
Actually... scratch this... phpdoc.org parser does not suport multiple
@package...
"ERROR in PraizedWP.php on line 14: DocBlock has multiple @package
tags, illegal. ignoring additional tag "@package PraizedTools""
Dam'it... I could swear it used to be okay...
Stephane
On Jul 07, 2008, at 22:44, Stephane Daury wrote:
>
> I also agree with @package for the plugin itself, and not just
> because that's what I've done in the codebase we're about to
> release. ;-)
>
> It's not specified in the phpdoc.org docs, but their parser supports
> multiple @package instances.
>
> So it could simply be:
> @package WordPress_Plugin
> @package PLUGIN_NAME
>
> Which would also have the advantage to let developers add their own
> @package when the WP plugin is one interface to a larger OSS
> codebase (*raises hand*), and this without breaking whatever parser
> the good wp core dev folks use for automated parsing.
>
> Stephane
>
>
> On Jul 07, 2008, at 22:17, Matt wrote:
>
>> I think @package PLUGIN_NAME would be the best.
>>
>> On Mon, Jul 7, 2008 at 5:59 PM, Jacob Santos
>> <wordpress at santosj.name> wrote:
>>> The main source @package used for WordPress is @package WordPress.
>>> My
>>> recommendation already does what you suggest. Which means we have an
>>> agreement.
>>>
>>> Jacob Santos
>>>
>>> Eric Marden wrote:
>>>>>
>>>>> What do you (plugin developers) set the @package and @subpackage
>>>>> names
>>>>> to?
>>>>>
>>>>> I usually do:
>>>>>
>>>>> @package WordPress_Plugin
>>>>> @subpackage PLUGIN_NAME
>>>>
>>>> Shouldn't the @package be whatever the main wordpress source is
>>>> in? The
>>>> only reason these are pertinent is so that the generated source
>>>> is organized
>>>> in a meaningful way. This would put the wp core in its own area,
>>>> outside of
>>>> all plugins. Is that what you're intending? I would vote for your
>>>> latter
>>>> suggestion of the plugin name as the @package, so that they are
>>>> all in their
>>>> own area outside of the core, or in the same @package as WP, but
>>>> the above
>>>> suggestion is not ideal in my honest opinion.
>>>>
>>>> -e
>>>>
>>>> _______________________________________________
>>>> wp-hackers mailing list
>>>> wp-hackers at lists.automattic.com
>>>> http://lists.automattic.com/mailman/listinfo/wp-hackers
>>>
>>> _______________________________________________
>>> wp-hackers mailing list
>>> wp-hackers at lists.automattic.com
>>> http://lists.automattic.com/mailman/listinfo/wp-hackers
>>>
>>
>>
>>
>> --
>> Matt (http://mattsblog.ca/)
>> _______________________________________________
>> wp-hackers mailing list
>> wp-hackers at lists.automattic.com
>> http://lists.automattic.com/mailman/listinfo/wp-hackers
>
> _______________________________________________
> wp-hackers mailing list
> wp-hackers at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-hackers
More information about the wp-hackers
mailing list