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?


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).

I've read somewhere that you generated this documenation automagically, how did you do that?

Tom

--
b e s t s o l u t i o n . a t                        EDV Systemhaus GmbH
------------------------------------------------------------------------
tom schindl        leiter softwareentwicklung   mobile  ++43 664 3145958
------------------------------------------------------------------------
eduard-bodem-gasse 8/3    A-6020 innsbruck      fax      ++43 512 935833
http://www.bestsolution.at                      phone    ++43 512 935834

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



Reply via email to