Skip to content

Loading…

Docblocks do not match #4341

Merged
merged 2 commits into from

2 participants

@localheinz
Zend Framework member

In a few classes I came across some issues with method doc-blocks not matching the actual method declarations. Also, some constructors have got @return annotations.

This PR fixes some of these mis-matches.

localheinz added some commits
@localheinz localheinz Fix doc-block
- Fix spelling error
- Update annotations
- Import class
- Order imports alphabetically
c9776cc
@localheinz localheinz Docblock doesn't match b10f31f
@weierophinney weierophinney merged commit b10f31f into zendframework:develop

1 check passed

Details default The Travis build passed
@localheinz localheinz deleted the localheinz:hotfix/docblocks-do-not-match branch
@ghost Unknown pushed a commit that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop
Close #4341
3cab0dd
@weierophinney weierophinney added a commit to zendframework/zend-authentication that referenced this pull request
@weierophinney weierophinney Merge pull request zendframework/zf2#4341 from localheinz/hotfix/docb…
…locks-do-not-match

Docblocks do not match
970ef51
@weierophinney weierophinney added a commit to zendframework/zend-authentication that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop c20974f
@weierophinney weierophinney added a commit to zendframework/zend-barcode that referenced this pull request
@weierophinney weierophinney Merge pull request zendframework/zf2#4341 from localheinz/hotfix/docb…
…locks-do-not-match

Docblocks do not match
2e5d145
@weierophinney weierophinney added a commit to zendframework/zend-barcode that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop 4223157
@weierophinney weierophinney added a commit to zendframework/zend-eventmanager that referenced this pull request
@weierophinney weierophinney Merge pull request zendframework/zf2#4341 from localheinz/hotfix/docb…
…locks-do-not-match

Docblocks do not match
2041a8b
@weierophinney weierophinney added a commit to zendframework/zend-eventmanager that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop 6fa20e6
@weierophinney weierophinney added a commit to zendframework/zend-test that referenced this pull request
@weierophinney weierophinney Merge pull request zendframework/zf2#4341 from localheinz/hotfix/docb…
…locks-do-not-match

Docblocks do not match
59bda17
@weierophinney weierophinney added a commit to zendframework/zend-test that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop 94f6ce2
@weierophinney weierophinney added a commit to zendframework/zend-stdlib that referenced this pull request
@weierophinney weierophinney Merge pull request zendframework/zf2#4341 from localheinz/hotfix/docb…
…locks-do-not-match

Docblocks do not match
abf298f
@weierophinney weierophinney added a commit to zendframework/zend-stdlib that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop 6954892
@weierophinney weierophinney added a commit to zendframework/zend-paginator that referenced this pull request
@weierophinney weierophinney Merge pull request zendframework/zf2#4341 from localheinz/hotfix/docb…
…locks-do-not-match

Docblocks do not match
7a12510
@weierophinney weierophinney added a commit to zendframework/zend-paginator that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop 9122dd7
@weierophinney weierophinney added a commit to zendframework/zend-console that referenced this pull request
@weierophinney weierophinney Merge pull request zendframework/zf2#4341 from localheinz/hotfix/docb…
…locks-do-not-match

Docblocks do not match
aab0943
@weierophinney weierophinney added a commit to zendframework/zend-console that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop 4592f82
@weierophinney weierophinney added a commit to zendframework/zend-filter that referenced this pull request
@weierophinney weierophinney Merge pull request zendframework/zf2#4341 from localheinz/hotfix/docb…
…locks-do-not-match

Docblocks do not match
c0690de
@weierophinney weierophinney added a commit to zendframework/zend-filter that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop 9ae353e
@weierophinney weierophinney added a commit to zendframework/zend-json that referenced this pull request
@weierophinney weierophinney Merge pull request zendframework/zf2#4341 from localheinz/hotfix/docb…
…locks-do-not-match

Docblocks do not match
2093d38
@weierophinney weierophinney added a commit to zendframework/zend-json that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop 536af8a
@weierophinney weierophinney added a commit to zendframework/zend-dom that referenced this pull request
@weierophinney weierophinney Merge pull request zendframework/zf2#4341 from localheinz/hotfix/docb…
…locks-do-not-match

Docblocks do not match
26a033e
@weierophinney weierophinney added a commit to zendframework/zend-dom that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop 0cf9f53
@weierophinney weierophinney added a commit to zendframework/zend-cache that referenced this pull request
@weierophinney weierophinney Merge pull request zendframework/zf2#4341 from localheinz/hotfix/docb…
…locks-do-not-match

Docblocks do not match
3cb979a
@weierophinney weierophinney added a commit to zendframework/zend-cache that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop c11ab4c
@weierophinney weierophinney added a commit to zendframework/zend-soap that referenced this pull request
@weierophinney weierophinney Merge pull request zendframework/zf2#4341 from localheinz/hotfix/docb…
…locks-do-not-match

Docblocks do not match
db0493f
@weierophinney weierophinney added a commit to zendframework/zend-soap that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop 9a50fc3
@weierophinney weierophinney added a commit to zendframework/zend-view that referenced this pull request
@weierophinney weierophinney Merge pull request zendframework/zf2#4341 from localheinz/hotfix/docb…
…locks-do-not-match

Docblocks do not match
60982f9
@weierophinney weierophinney added a commit to zendframework/zend-view that referenced this pull request
@weierophinney weierophinney Merge branch 'hotfix/4341' into develop e693c02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Apr 28, 2013
  1. @localheinz

    Fix doc-block

    localheinz committed
    - Fix spelling error
    - Update annotations
    - Import class
    - Order imports alphabetically
  2. @localheinz

    Docblock doesn't match

    localheinz committed
View
11 library/Zend/Authentication/Adapter/DbTable/CallbackCheckAdapter.php
@@ -27,12 +27,11 @@ class CallbackCheckAdapter extends AbstractAdapter
/**
* __construct() - Sets configuration options
*
- * @param DbAdapter $zendDb
- * @param string $tableName Optional
- * @param string $identityColumn Optional
- * @param string $credentialColumn Optional
- * @param callable $credentialValidationCallback Optional
- * @return \Zend\Authentication\Adapter\DbTable
+ * @param DbAdapter $zendDb
+ * @param string $tableName Optional
+ * @param string $identityColumn Optional
+ * @param string $credentialColumn Optional
+ * @param callable $credentialValidationCallback Optional
*/
public function __construct(
DbAdapter $zendDb,
View
11 library/Zend/Authentication/Adapter/DbTable/CredentialTreatmentAdapter.php
@@ -27,12 +27,11 @@ class CredentialTreatmentAdapter extends AbstractAdapter
/**
* __construct() - Sets configuration options
*
- * @param DbAdapter $zendDb
- * @param string $tableName Optional
- * @param string $identityColumn Optional
- * @param string $credentialColumn Optional
- * @param string $credentialTreatment Optional
- * @return \Zend\Authentication\Adapter\DbTable
+ * @param DbAdapter $zendDb
+ * @param string $tableName Optional
+ * @param string $identityColumn Optional
+ * @param string $credentialColumn Optional
+ * @param string $credentialTreatment Optional
*/
public function __construct(
DbAdapter $zendDb,
View
12 library/Zend/Barcode/Renderer/Pdf.php
@@ -138,13 +138,13 @@ protected function drawPolygon($points, $color, $filled = true)
/**
* Draw a polygon in the rendering resource
- * @param string $text
- * @param float $size
- * @param array $position
- * @param string $font
+ * @param string $text
+ * @param float $size
+ * @param array $position
+ * @param string $font
* @param integer $color
- * @param string $alignment
- * @param float $orientation
+ * @param string $alignment
+ * @param float $orientation
*/
protected function drawText(
$text,
View
2 library/Zend/Cache/Storage/Adapter/SessionOptions.php
@@ -27,7 +27,7 @@ class SessionOptions extends AdapterOptions
/**
* Set the session container
*
- * @param null|SessionContainer $memoryLimit
+ * @param null|SessionContainer $sessionContainer
* @return SessionOptions
*/
public function setSessionContainer(SessionContainer $sessionContainer = null)
View
1 library/Zend/Console/Color/Xterm256.php
@@ -30,7 +30,6 @@ class Xterm256
* Populate color property with X11-formatted equivalent
*
* @param mixed $color
- * @return void
*/
protected function __construct($color = null)
{
View
5 library/Zend/Db/Adapter/Driver/IbmDb2/IbmDb2.php
@@ -33,9 +33,8 @@ class IbmDb2 implements DriverInterface, Profiler\ProfilerAwareInterface
/**
* @param array|Connection|resource $connection
- * @param null|Statement $statementPrototype
- * @param null|Result $resultPrototype
- * @param string $features
+ * @param null|Statement $statementPrototype
+ * @param null|Result $resultPrototype
*/
public function __construct($connection, Statement $statementPrototype = null, Result $resultPrototype = null)
{
View
2 library/Zend/Db/Adapter/Driver/Mysqli/Connection.php
@@ -132,7 +132,7 @@ public function getCurrentSchema()
/**
* Set resource
*
- * @param mysqli $resource
+ * @param \mysqli $resource
* @return Connection
*/
public function setResource(\mysqli $resource)
View
3 library/Zend/Db/Adapter/Driver/Oci8/Oci8.php
@@ -195,7 +195,8 @@ public function createStatement($sqlOrResource = null)
}
/**
- * @param resource $resource
+ * @param resource $resource
+ * @param null $isBuffered
* @return Result
*/
public function createResult($resource, $isBuffered = null)
View
2 library/Zend/Db/Adapter/Platform/PlatformInterface.php
@@ -87,7 +87,7 @@ public function getIdentifierSeparator();
* Quote identifier in fragment
*
* @param string $identifier
- * @param array $safeWords
+ * @param array $additionalSafeWords
* @return string
*/
public function quoteIdentifierInFragment($identifier, array $additionalSafeWords = array());
View
14 library/Zend/Dom/NodeList.php
@@ -52,11 +52,10 @@ class NodeList implements Iterator, Countable, ArrayAccess
/**
* Constructor
*
- * @param string $cssQuery
- * @param string|array $xpathQuery
- * @param DOMDocument $document
- * @param DOMNodeList $nodeList
- * @return void
+ * @param string $cssQuery
+ * @param string|array $xpathQuery
+ * @param DOMDocument $document
+ * @param DOMNodeList $nodeList
*/
public function __construct($cssQuery, $xpathQuery, DOMDocument $document, DOMNodeList $nodeList)
{
@@ -192,7 +191,8 @@ public function offsetGet($key)
/**
* ArrayAccess: set offset
*
- * @return void
+ * @param mixed $key
+ * @param mixed $value
* @throws Exception\BadMethodCallException when attemptingn to write to a read-only item
*/
public function offsetSet($key, $value)
@@ -203,7 +203,7 @@ public function offsetSet($key, $value)
/**
* ArrayAccess: unset offset
*
- * @return void
+ * @param mixed $key
* @throws Exception\BadMethodCallException when attemptingn to unset a read-only item
*/
public function offsetUnset($key)
View
2 library/Zend/EventManager/StaticEventManager.php
@@ -22,8 +22,6 @@ class StaticEventManager extends SharedEventManager
/**
* Singleton
- *
- * @return void
*/
protected function __construct()
{
View
3 library/Zend/Filter/UriNormalize.php
@@ -34,8 +34,7 @@ class UriNormalize extends AbstractFilter
/**
* Sets filter options
*
- * @param array|\Traversable|null $options
- * @return void
+ * @param array|\Traversable|null $options
*/
public function __construct($options = null)
{
View
8 library/Zend/Form/FormAbstractServiceFactory.php
@@ -47,8 +47,9 @@ public function createServiceWithName(ServiceLocatorInterface $serviceLocator, $
}
/**
- * @param array $spec
- * @return \Zend\Form\FormInterface
+ * @param ServiceLocatorInterface $serviceLocator
+ * @param array $spec
+ * @return ElementInterface
*/
public function createForm(ServiceLocatorInterface $serviceLocator, $spec = array())
{
@@ -68,7 +69,8 @@ public function setFormFactory(Factory $formFactory)
}
/**
- * @return \Zend\Form\Factory
+ * @param ServiceLocatorInterface $serviceLocator
+ * @return Factory
*/
public function getFormFactory(ServiceLocatorInterface $serviceLocator)
{
View
5 library/Zend/Json/Decoder.php
@@ -78,12 +78,11 @@ class Decoder
/**
* Constructor
*
- * @param string $source String source to decode
- * @param int $decodeType How objects should be decoded -- see
+ * @param string $source String source to decode
+ * @param int $decodeType How objects should be decoded -- see
* {@link Zend\Json\Json::TYPE_ARRAY} and {@link Zend\Json\Json::TYPE_OBJECT} for
* valid values
* @throws InvalidArgumentException
- * @return void
*/
protected function __construct($source, $decodeType)
{
View
2 library/Zend/Json/Server/Server.php
@@ -155,8 +155,8 @@ public function fault($fault = null, $code = 404, $data = null)
* Handle request
*
* @param Request $request
- * @throws Exception\InvalidArgumentException
* @return null|Response
+ * @throws Exception\InvalidArgumentException
*/
public function handle($request = false)
{
View
3 library/Zend/Mvc/Controller/AbstractRestfulController.php
@@ -168,7 +168,8 @@ public function options()
* Not marked as abstract, as that would introduce a BC break
* (introduced in 2.1.0); instead, raises an exception if not implemented.
*
- * @return mixed
+ * @param $id
+ * @param $data
* @throws Exception\RuntimeException
*/
public function patch($id, $data)
View
6 library/Zend/Paginator/Adapter/DbTableGateway.php
@@ -9,16 +9,18 @@
namespace Zend\Paginator\Adapter;
-use Zend\Paginator\Adapter\DbSelect;
+use Zend\Db\Sql\Where;
use Zend\Db\TableGateway\TableGateway;
+use Zend\Paginator\Adapter\DbSelect;
class DbTableGateway extends DbSelect
{
/**
- * Construnct
+ * Constructs instance.
*
* @param TableGateway $tableGateway
* @param Where|\Closure|string|array $where
+ * @param null $order
*/
public function __construct(TableGateway $tableGateway, $where = null, $order = null)
{
View
3 library/Zend/Soap/AutoDiscover.php
@@ -150,8 +150,9 @@ public function getClassMap()
/**
* Set the class map of php to wsdl qname types.
*
- * @param array $classmap
+ * @param array $classmap
* @return AutoDiscover
+ * @throws Exception\InvalidArgumentException
*/
public function setClassMap($classMap)
{
View
7 library/Zend/Stdlib/ArrayObject/PhpLegacyCompatibility.php
@@ -24,10 +24,9 @@
/**
* Constructor
*
- * @param array $input
- * @param int $flags
- * @param string $iteratorClass
- * @return ArrayObject
+ * @param array $input
+ * @param int $flags
+ * @param string $iteratorClass
*/
public function __construct($input = array(), $flags = self::STD_PROP_LIST, $iteratorClass = 'ArrayIterator')
{
View
7 library/Zend/Stdlib/ArrayObject/PhpReferenceCompatibility.php
@@ -59,10 +59,9 @@
/**
* Constructor
*
- * @param array $input
- * @param int $flags
- * @param string $iteratorClass
- * @return ArrayObject
+ * @param array $input
+ * @param int $flags
+ * @param string $iteratorClass
*/
public function __construct($input = array(), $flags = self::STD_PROP_LIST, $iteratorClass = 'ArrayIterator')
{
View
6 library/Zend/Stdlib/Hydrator/AbstractHydrator.php
@@ -102,9 +102,9 @@ public function removeStrategy($name)
/**
* Converts a value for extraction. If no strategy exists the plain value is returned.
*
- * @param string $name The name of the strategy to use.
- * @param mixed $value The value that should be converted.
- * @param array $data The object is optionally provided as context.
+ * @param string $name The name of the strategy to use.
+ * @param mixed $value The value that should be converted.
+ * @param array $object The object is optionally provided as context.
* @return mixed
*/
public function extractValue($name, $value, $object = null)
View
7 library/Zend/Test/Util/ModuleLoader.php
@@ -20,7 +20,8 @@ class ModuleLoader
/**
* Load list of modules or application configuration
- * @param array $modules
+ *
+ * @param array $configuration
*/
public function __construct(array $configuration)
{
@@ -50,6 +51,7 @@ public function __construct(array $configuration)
/**
* Get the application
+ *
* @return Zend\Mvc\Application
*/
public function getApplication()
@@ -59,6 +61,7 @@ public function getApplication()
/**
* Get the module manager
+ *
* @return Zend\ModuleManager\ModuleManager
*/
public function getModuleManager()
@@ -68,6 +71,7 @@ public function getModuleManager()
/**
* Get module
+ *
* @return mixed
*/
public function getModule($moduleName)
@@ -77,6 +81,7 @@ public function getModule($moduleName)
/**
* Get the service manager
+ *
* @var ServiceManager
*/
public function getServiceManager()
View
4 library/Zend/View/Helper/Navigation/Listener/AclListener.php
@@ -27,8 +27,8 @@ class AclListener
* - Page is accepted if it has no resource or privilege.
* - Page is accepted if ACL allows page's resource or privilege.
*
- * @param MvcEvent $event
- * @return boolean
+ * @param Event $event
+ * @return bool
*/
public static function accept(Event $event)
{
View
9 library/Zend/View/Stream.php
@@ -48,6 +48,10 @@ class Stream
/**
* Opens the script file and converts markup.
*
+ * @param string $path
+ * @param $mode
+ * @param $options
+ * @param $opened_path
* @return bool
*/
public function stream_open($path, $mode, $options, &$opened_path)
@@ -95,7 +99,8 @@ public function url_stat()
/**
* Reads from the stream.
*
- * @return string|false
+ * @param int $count
+ * @return string
*/
public function stream_read($count)
{
@@ -141,6 +146,8 @@ public function stream_stat()
/**
* Seek to a specific point in the stream.
*
+ * @param $offset
+ * @param $whence
* @return bool
*/
public function stream_seek($offset, $whence)
Something went wrong with that request. Please try again.