Well here is one example. What are the options for this particular method?
Return JavaScript text for an observer...
Parameters:
string $klass Name of JavaScript class
string $name
array $options Ajax options
Returns:
string Formatted JavaScript
Definition at line 864 of file ajax.php.
References remoteFunction(), and Helper::value().
Referenced by observeField(), and observeForm().
On php.net all the functions are very well documented for instance it's
immediately clear what this function does and what it's parameters do and
what they are.
http://us.php.net/manual/en/function.mysql-affected-rows.php
-----Original Message-----
From: cake-php@googlegroups.com [mailto:cake-...@googlegroups.com] On Behalf
Of mark_story
Sent: Saturday, January 03, 2009 6:59 PM
To: CakePHP
Subject: Re: API
Its not bitching if you are willing to point out where the problems are and
perhaps offer some solutions to those problems. That's called contributing
in my books. As for the API it is automatically generated via doxygen. But
just because it is auto generated means it should be poor. So again, some
places where you think the API is weak would help as you are probably not
the only person who has experienced issues with it.
-Mark
On Jan 3, 3:47 pm, Steven Wright <rhythmicde...@gmail.com> wrote:
> Yeah. I am pretty sure the docs are auto created probably like Java Doc.
> But I cant really bitch too much about what is essentially a free
framework.
>
> -----Original Message-----
> From: cake-php@googlegroups.com [mailto:cake-...@googlegroups.com] On
> Behalf
>
> Of brian
> Sent: Saturday, January 03, 2009 3:43 PM
> To: cake-php@googlegroups.com
> Subject: Re: API
>
> On Sat, Jan 3, 2009 at 3:18 PM, rhythmicde...@gmail.com
> <rhythmicde...@gmail.com> wrote:
>
> > Ahh I dont want to be all whiny about it :)
>
> > Essentially if there are options the options should be listed.
>
> Agreed. The API docs are a misery to wade through at times. Especially
> for figuring out things like $options.
>
> It'd also be nice if there were a few comment blocks *within* some of
> the class methods. I do realise that that wouldn't be trivial to deal
> with, though.
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"CakePHP" group.
To post to this group, send email to cake-php@googlegroups.com
To unsubscribe from this group, send email to
cake-php+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/cake-php?hl=en
-~----------~----~----~----~------~----~------~--~---
