ZF-8665: Docblocks in several Zend_Measure_Abstract methods contain specific, rather than general, types

Issue Type: Docs: Improvement Created: 2009-12-29T18:53:22.000+0000 Last Updated: 2009-12-30T14:44:55.000+0000 Status: Resolved Fix version(s): - 1.10.0 (27/Jan/10)

Reporter: David Weinraub (papayasoft) Assignee: Thomas Weidner (thomas) Tags: - Zend_Measure

Related issues: Attachments:


In the DocBlock for the method Zend_Measure_Abstract::setValue(), the $type parameter is described as:

@param string $type OPTIONAL A Zend_Measure_Acceleration Type

I can't imagine that we want the specific "Zend_Measure_Acceleration". The $type required here is just the index into the _units array. We just want to give an example. I imagine we just need something like:

@param string $type OPTIONAL The type of the value. Ex: Zend_Measure_Acceleration::GALILEO

Similarly, the docblock for the constructor itself contains a reference to a specific type:

@param $type type - OPTIONAL a Zend_Measure_Area Type

Probably better is:

@param string $type OPTIONAL The type of the value. Ex: Zend_Measure_Area::SQUARE_METER


Posted by Thomas Weidner (thomas) on 2009-12-30T14:44:55.000+0000

Changed with r19987

Have you found an issue?

See the Overview section for more details.


© 2006-2018 by Zend, a Rogue Wave Company. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.