[wp-hackers] Hook (Filter, Action) Documentation Idea

hakre hanskrentel at yahoo.de
Thu Sep 9 10:20:10 UTC 2010

----- Ursprüngliche Mail ----

> Von: Andrew Nacin <wp at andrewnacin.com>
> An: wp-hackers at lists.automattic.com
> Gesendet: Mittwoch, den 8. September 2010, 23:42:49 Uhr
> Betreff: Re: [wp-hackers] Hook (Filter, Action) Documentation Idea
> On Wed, Sep 8, 2010 at 4:29 PM, Jacob Santos <wordpress at santosj.name>  wrote:
> > Well, my point was that given the large number of hooks, that  it is almost
> > impractical to create a separate method or function  describing each hook.
> > 300 or 400 is probably the limit I would be at.  Also, given the
> > already intermittent nature of inline documentation  corrections, updates
> > and
> > additions; it seems somewhat  problematic to force people into adding a new
> > method when they add a new  filter or action.
> Indeed, that does seem problematic. Way too much to  maintain.

The amount of work equals the one of any other kind of documentation for the 
documentation part. The amount of work it can save because it makes use of 
existing tools and is compatible to existing tools is hard for me to measure, 
but I assume, it will save some work.

> About a week ago a few of us were discussing the possibility of  creating our
> own docblocks that we would use inline before each hook, such as  /*wp ...
> */. This is in the context not of phpxref or phpdocumentor, but as  part of
> our planning for our own API reference site that will document every  class,
> function, and hook. You're welcome to join the API dev list  at
> lists.wordpress.org and we can move this discussion  there.

That's somehow related, right. Infact that file I suggest could represent the 
API (and as it has been already pointed out, easy to integrte with IDEs 

-- hakre

More information about the wp-hackers mailing list