Hi,
There's certainly room for improvement in some areas of the docs, but
personally I find ZF better-documented than many other open-source projects
- and there's always the option of submitting improved documentation to the
issue tracker!

1.  I've only used Zend_Translate briefly, but most of the options seem to
be documented at 
http://framework.zend.com/manual/en/zend.translate.using.html#zend.translate.using.options

2.  Ditto.  If you need to catch specific exceptions (although this is never
something I've had to do with ZF), you'll need to look at the source - and
then submit a patch with updated comments.

3.  Not sure what you mean by that.


Cheers,
Mark




umpirsky wrote:
> 
> Hi.
> 
> I'm working with zf for a while, and I noticed some things:
> 
> 1. Many methods and constructors, are poorly documented.
> Example: Zend_Translate constructor
> 
> /**
>      * Generates the standard translation object
>      *
>      * @param  string              $adapter  Adapter to use
>      * @param  array               $data     Translation source data for
> the
> adapter
>      *                                       Depends on the Adapter
>      * @param  string|Zend_Locale  $locale   OPTIONAL locale to use
>      * @param  array               $options  OPTIONAL options for the
> adapter
>      * @throws Zend_Translate_Exception
>      */
>     public function __construct($adapter, $data, $locale = null, array
> $options = array())
> 
> by looking at this, I don't know what are the possible options, which keys
> can it have and what do they mean? Is there any simple way to find out?
> (There are many wxamples like this Zend_Db::factory...)
> 
> 2. Some methods don't have @throw declared, but they still throw
> exceptions
> in some cases. How to know what to catch?
> 
> 3. It's fine to have constants instead hardcoded strings sometimes:
> 
> $form->addElement('text', 'username');
> 
> $username->addValidator('alnum');
> 
> 
> Regards,
> Saša Stamenković
> 
> 

-- 
View this message in context: 
http://www.nabble.com/Little-things-that-mean-so-much-tp23535267p23535541.html
Sent from the Zend Framework mailing list archive at Nabble.com.

Reply via email to