-- Matthew Lurz <[EMAIL PROTECTED]> wrote
(on Tuesday, 19 August 2008, 10:38 PM -0700):
> 
> Correct. Other than specifying a return type of void in the docblock there is
> nothing more to document.

All RPC methods need to have a return value stated, even if it is a void
or null; RPC _always_ has a return payload.

At the minimum, you need a docblock like the following on your method:

    /**
     * @return void
     */
    public function doNada()
    {
    }

This is how _all_ ZF server components work, and it's just good practice
to do this for your code. (API doc generators, etc., need this.)

> tfk wrote:
> > 
> > On Wed, Aug 20, 2008 at 12:58 AM, Matthew Lurz <[EMAIL PROTECTED]> wrote:
> >>
> >> I'm unsure of what to document since there are no params to the method
> >> nor a
> >> return value. I'll try to add an @return void and see if that helps. I
> >> don't
> >> need to do anything different in the controller do I? It seems like this
> >> is
> >> handled in jsonRpcAction. Also, I think I must need to hookup the submit
> >> button in my form to behave differently somehow. Any insights?
> > 
> > You *need* to document the class 'Options', or are you saying there is
> > nothing to document in there?

-- 
Matthew Weier O'Phinney
Software Architect       | [EMAIL PROTECTED]
Zend Framework           | http://framework.zend.com/

Reply via email to