Author: as
Date: Thu Oct 11 16:11:06 2007
New Revision: 6429
Log:
- Some fixes in code comments.
Modified:
trunk/Feed/src/interfaces/module.php
trunk/Feed/src/interfaces/processor.php
trunk/Feed/src/modules/content.php
trunk/Feed/src/processors/atom.php
Modified: trunk/Feed/src/interfaces/module.php
==============================================================================
--- trunk/Feed/src/interfaces/module.php [iso-8859-1] (original)
+++ trunk/Feed/src/interfaces/module.php [iso-8859-1] Thu Oct 11 16:11:06 2007
@@ -76,7 +76,7 @@
*
* It is a hook called before setting the feed $element to $value.
*
- * @param array(string=>mixed) The module data
+ * @param array(string=>mixed) $moduleData The module data
* @param string $element The name of the feed element
* @param mixed $value The new value for $element
* @return bool
@@ -101,7 +101,7 @@
*
* It is a hook called before setting the feed $element to $value.
*
- * @param array(string=>mixed) The item module data
+ * @param array(string=>mixed) $moduleData The item module data
* @param string $element The name of the feed element
* @param mixed $value The new value for $element
* @return bool
Modified: trunk/Feed/src/interfaces/processor.php
==============================================================================
--- trunk/Feed/src/interfaces/processor.php [iso-8859-1] (original)
+++ trunk/Feed/src/interfaces/processor.php [iso-8859-1] Thu Oct 11 16:11:06
2007
@@ -85,7 +85,7 @@
/**
* Returns true if $moduleName is supported by this processor, false
otherwise.
*
- * @var string $moduleName The module name (eg. 'DublinCore')
+ * @param string $moduleName The module name (eg. 'DublinCore')
* @return bool
*/
public function isModuleSupported( $moduleName )
@@ -127,7 +127,7 @@
* @param ezcFeedItem $item The instance of the feed item
* @return ezcFeedItemModuleData
*/
- public function addItemModule( $moduleName, $moduleObj, $item )
+ public function addItemModule( $moduleName, ezcFeedModule $moduleObj,
ezcFeedItem $item )
{
if ( !$this->isModuleSupported( $moduleName ) )
{
@@ -143,11 +143,11 @@
*
* @param string $moduleName The type of the module
* @param ezcFeedModule $moduleObj The module object
- * @param ezcFeedItem $item The feed item object
* @param string $element The element in the module
- * @return mixed
- */
- public function setModuleMetaData( $moduleName, $moduleObj, $element,
$value )
+ * @param string $value The new value for $element
+ * @return mixed
+ */
+ public function setModuleMetaData( $moduleName, ezcFeedModule $moduleObj,
$element, $value )
{
$value = $moduleObj->prepareMetaData( $element, $value );
$this->moduleMetaData[$moduleName][$element] = $value;
@@ -162,7 +162,7 @@
* @param string $element The element in the module
* @return mixed
*/
- public function getModuleMetaData( $moduleName, $moduleObj, $element )
+ public function getModuleMetaData( $moduleName, ezcFeedModule $moduleObj,
$element )
{
if ( isset( $this->moduleMetaData[$moduleName][$element] ) )
{
@@ -204,9 +204,10 @@
* @param ezcFeedModule $moduleObj The module object
* @param ezcFeedItem $item The feed item object
* @param string $element The element in the module
- * @return mixed
- */
- public function setModuleItemData( $moduleName, $moduleObj, ezcFeedItem
$item, $element, $value )
+ * @param string $value The new value for $element
+ * @return mixed
+ */
+ public function setModuleItemData( $moduleName, ezcFeedModule $moduleObj,
ezcFeedItem $item, $element, $value )
{
$value = $moduleObj->prepareMetaData( $element, $value );
$item->setModuleMetaData( $moduleName, $moduleObj, $element, $value );
@@ -302,7 +303,7 @@
* This hook is called before calling setMetaData() with the $element and
$value
* arguments for the feed item $item.
*
- * @param ezcFeedItem $feed The feed item object
+ * @param ezcFeedItem $item The feed item object
* @param string $element The name of the element to set
* @param mixed $value The new value for $element
*/
Modified: trunk/Feed/src/modules/content.php
==============================================================================
--- trunk/Feed/src/modules/content.php [iso-8859-1] (original)
+++ trunk/Feed/src/modules/content.php [iso-8859-1] Thu Oct 11 16:11:06 2007
@@ -114,7 +114,7 @@
*
* It is a hook called before setting the feed $element to $value.
*
- * @param array(string=>mixed) The module data
+ * @param array(string=>mixed) $moduleData The module data
* @param string $element The name of the feed element
* @param mixed $value The new value for $element
* @return bool
@@ -145,7 +145,7 @@
*
* It is a hook called before setting the feed $element to $value.
*
- * @param array(string=>mixed) The item module data
+ * @param array(string=>mixed) $moduleData The item module data
* @param string $element The name of the feed element
* @param mixed $value The new value for $element
* @return bool
Modified: trunk/Feed/src/processors/atom.php
==============================================================================
--- trunk/Feed/src/processors/atom.php [iso-8859-1] (original)
+++ trunk/Feed/src/processors/atom.php [iso-8859-1] Thu Oct 11 16:11:06 2007
@@ -10,6 +10,8 @@
*/
/**
+ * Class providing parsing and generating of ATOM feeds.
+ *
* @package Feed
* @version //autogentag//
*/
@@ -150,7 +152,7 @@
* @param ezcFeed $feed The feed object in which to store the parsed XML
element as a feed item
* @param DOMElement $xml The XML element object to parse
*/
- public function parseItem( ezcFeed $feed, DOMElement $item )
+ public function parseItem( ezcFeed $feed, DOMElement $xml )
{
}
--
svn-components mailing list
[email protected]
http://lists.ez.no/mailman/listinfo/svn-components
