[wp-hackers] phpdoc for taxonomy API

Jacob Santos dragonwing at dragonu.net
Wed Aug 15 12:51:55 GMT 2007

Thanks, but until the original developer(s) of the API or someone 
confirms the phpDoc description, I'm going to keep it in.

What I did, was read the function code based on the parameters and 
create a flow. Based on if I was a hacker and needing to know what the 
functions were, I would make the assumptions based in the phpDoc. It is 
by no means meant to be a final patch.

I may have added my opinion with WP_Error usage. Which I think is 
interesting, but would have to be conveyed to the user as a possible 
return. On functions that don't return anything, I believe I also gave 
my opinion. Really, with those functions (or methods), you shouldn't use 
@returns because technically, no value is returned.

Jacob Santos

Joseph Scott wrote:
> On Aug 14, 2007, at 10:42 PM, Jacob Santos wrote:
>> I added a patch that adds phpDoc tags to the taxonomy API. Let me 
>> know what you think of the style. Basically it is more of a copy, 
>> paste, and edit for the simple functions. phpDoc is not that 
>> difficult, so just check over the notes and see if I'm correct in my 
>> assumptions. I'm going to be adding another patch depending on feedback.
> I think this looks like a great start.  I would avoid words like 
> "appears" though.
> Perhaps it would be best to leave out the text descriptions unless 
> sure of what the function does.
> -- 
> Joseph Scott
> http://joseph.randomnetworks.com/
> _______________________________________________
> 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