Stas Bekman wrote:
Tom Schindl wrote: [...]
It doesn't matter to me. If you prefer to have:
* obj: $socket * arg1: $len
I'd also prefer to have it this way. How does this look like for static methods?
* class: APR::SOCKET * arg1: $len
You mean for something like:
Apache->warn(@msg);
you suggest to have:
class: Apache arg1: @msg
correct? Though it can be $r->warn(@msg) just as well. (Please disregard for a moment that Apache::Log is a big mess, which we need to rectify). Another example would be Apache->request().
Static implies that you can also call it as an instance method, doesn't it?
Usually, yes. But we normally refer to those as class methods I believe.
Why could you not leave the obj/class. You would not state the obj/class for any other object oriented language like e.g. java, when using objects this is implied, isn't it? Normally one only marks methods to be static/instance and private/protected/public.
Sorry, I'm not following you here, Tom. What are you suggesting again?
Well when looking at e.g. Java-API-Doc you'll never see class/obj and you'll document methods like this:
package Apache
* public static warn arg1: Array @msg ... Array of Messages
package APR::SOCKET * public recv arg1: int $len ... length of messages
Creating API-documentation like java has one is very common and the same is true for UML where one does not add an arg0: obj because it's implied in Object Oriented Contexts.
Besides that. I've already created once a UML Documentation of mod_perl-1+AxKit and I've already a AxKit-Plugin to render UML-Documentation-Files encoded into XMI (a XML-Standard-Format for UML-Diagramms).
Yes, but many of mod_perl users aren't OO-savvy, so we want things to be as clear as possible, w/o relying on anything that could imply to those with OO background.
Besides, in Java everything is OO, not so in mod_perl. We have class functions and class methods, in addition to normal methods.
I've read somewhere that you generated this documenation automagically, how did you do that?
Gerald Richter further extended ExtUtils::WrapXS originally written by Doug, to also pick the C source doxygen comments and convert them into pod (besides many other changes). See ExtUtils::XSBuilder on CPAN.
-- __________________________________________________________________ Stas Bekman JAm_pH ------> Just Another mod_perl Hacker http://stason.org/ mod_perl Guide ---> http://perl.apache.org mailto:[EMAIL PROTECTED] http://use.perl.org http://apacheweek.com http://modperlbook.org http://apache.org http://ticketmaster.com
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
