Tom Schindl wrote:
Stas Bekman wrote:
Tom Schindl wrote:
[...]
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.
Ok. I see your point and that's why I'd vote for your second suggestion:
$socket->recv: * obj: $socket * arg1: $len
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.
Good to know, thanks.
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]
