[wp-hackers] questions about PHPdoc and plugins

[Jacob Santos]

Well, for an example of an highly documented plugin, you can take a look 
at http://wordpress.org/extend/plugins/alternative-mailer/.

Jacob Santos

Krusty Ruffle wrote:
> Thanks for the reply! I hope I didn't come across as putting down the
> documentation in the WordPress source code, that was not my intent at all. I
> was confused about what I needed to do to add similar documentation to a
> plugins source code. I guess I had been hoping that there would be a
> skeleton file or something along those lines that could be used to help
> people understand what needs to be documented in a plugin. I eventually came
> to the conclusion that putting docblocks in there for the functions would be
> acceptable, especially for a plugin as simple as the one I wrote :)
>
> And really, the documentation in that source code has improved an
> unbelievable amount lately. I've found it to be much easier to figure things
> out when looking at the source code, that's why I wondered about putting it
> in a plugin, I though it would be good to follow suite...
>
> Thanks again, for the reply, and the documentation efforts. It is greatly
> appreciated :)
>
> Mostly, I would say that it takes practice. The documentation in the source
>   
>> of WordPress isn't perfect, and a lot has changed to the standard in order
>> to make it so. I apologize that the documentation isn't that clear.
>>
>> I find that visual helps a lot with writing phpdoc style documentation, as
>> well as DocBook style documentation for that matter. The reason why the wiki
>> works so well, is that you can see it.
>>
>> Jacob Santos
>> _______________________________________________
>> 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
>