ZF-11210: Zend_Feed_Writer_Entry docblock mismatch

Issue Type:
Docs: Problem
Created:
2011-03-22T23:30:46.000+0000
Last Updated:
2011-09-09T22:13:10.000+0000
Status:
Resolved
Fix version(s):
  • Next Major Release ()
Reporter:
John Flatness (zerocrates)
Assignee:
Thomas Weidner (thomas)
Tags:
  • Zend_Feed_Writer
Related issues:
Attachments:

Description

The PHPDoc block for {{Zend_Feed_Writer_Entry::setEnclosure}} includes {{@param array $enclosures}}.

The actual parameter is named {{$enclosure}} (no 's').

Aside from the wrong name being misleading, it causes the generated API docs to claim that setEnclosure takes two arguments.

Comments

Posted by John Flatness (zerocrates) on 2011-07-13T01:06:27.000+0000

The new DocBlox generator seems to deal with the mismatched arg names better; it doesn't show two arguments like the old phpDocumentor docs did.

The mismatched names are still causing the generated docs to not correctly show that the {{$enclosure}} arg is an array.

Posted by Thomas Weidner (thomas) on 2011-09-09T22:13:10.000+0000

Fixed in ZF2 with GH-402