ZF-9324: Zend_View_Helper_HeadTitle wrong params in code ws comments and API documentation

Issue Type:
Patch
Created:
2010-03-04T05:25:08.000+0000
Last Updated:
2010-11-18T16:57:14.000+0000
Status:
Resolved
Fix version(s):
  • 1.11.1 (30/Nov/10)
Reporter:
Cristian Bichis (avantis)
Assignee:
Ramon Henrique Ornelas (ramon)
Tags:
  • Zend_View
Related issues:
Attachments:

Description

Hi,

The Api documentation:

Zend_View_Helper_HeadTitle headTitle ([string $title = null], [string $setType = Zend_View_Helper_Placeholder_Container_Abstract::APPEND], string $separator)

The comments above the function: /** * Retrieve placeholder for title element and optionally set state * * @param string $title * @param string $setType * @param string $separator * @return Zend_View_Helper_HeadTitle */

The function:

public function headTitle($title = null, $setType = Zend_View_Helper_Placeholder_Container_Abstract::APPEND)

So, as you can see the function params doesn't match with documentation and comments params.

As far as i checked there are no ways to actually set the separator...

Comments

Posted by Cristian Bichis (avantis) on 2010-03-04T05:33:03.000+0000

For the later part, about setting the separator i was wrong, this can be done by setSeparator...

Posted by __jul__ (__jul__) on 2010-04-27T19:19:05.000+0000

I've uploaded a patch which removes "@param string $separator" from the docblock.

This should bring the API documentation for the headTitle() method inline with the method's current signature.

Posted by Ramon Henrique Ornelas (ramon) on 2010-11-18T16:57:13.000+0000

Fixed in trunk r23386 merged to release branch r23388.