Author: as
Date: Mon Oct 8 15:32:08 2007
New Revision: 6392
Log:
- Some documentation fixes.
Modified:
trunk/Feed/src/feed.php
Modified: trunk/Feed/src/feed.php
==============================================================================
--- trunk/Feed/src/feed.php [iso-8859-1] (original)
+++ trunk/Feed/src/feed.php [iso-8859-1] Mon Oct 8 15:32:08 2007
@@ -305,6 +305,11 @@
/**
* Adds a new module to the feed.
*
+ * Example:
+ * <code>
+ * $feed->addModule( 'ezcFeedModuleDublinCode' );
+ * </code>
+ *
* @var string $className The type of the module
*/
public function addModule( $className )
@@ -321,6 +326,11 @@
/**
* Creates and returns a new feed item for this feed.
+ *
+ * Example:
+ * <code>
+ * $item = $feed->newItem();
+ * </code>
*
* @return ezcFeedItem
*/
@@ -397,6 +407,11 @@
* Parses the XML document in the $uri and returns an ezcFeed object with
* the type autodetected from the XML document.
*
+ * Example of parsing an XML document stored in an URI:
+ * <code>
+ * $feed = ezcFeed::parse( 'http://www.example.com/rss2.xml' );
+ * </code>
+ *
* @throws ezcBaseFileNotFoundException
* If the XML file at $uri could not be found.
*
@@ -418,6 +433,12 @@
* Parses the XML document stored in $content and returns an ezcFeed object
* with the type autodetected from the XML document.
*
+ * Example of parsing an XML document stored in a string:
+ * <code>
+ * // $xmlString contains a valid XML document
+ * $feed = ezcFeed::parse( $xmlString );
+ * </code>
+ *
* @throws ezcFeedParseErrorException
* If $content is not a valid XML document.
*
@@ -449,7 +470,7 @@
/**
* Returns the supported modules (the [EMAIL PROTECTED]
self::$supportedModules} array).
*
- * @return array(string)
+ * @return array(string=>string)
*/
public static function getSupportedModules()
{
@@ -473,7 +494,7 @@
* handle it.
*
* @throws ezcFeedCanNotParseException
- * If the $xml document could not be parsed by any available
processor.
+ * If the $xml object could not be parsed by any available
processor.
*
* @param DOMDocument $xml The XML object to parse
* @return ezcFeed
--
svn-components mailing list
[email protected]
http://lists.ez.no/mailman/listinfo/svn-components
