[change] we now use Full-Text RSS 3.1, thank you so much @fivefilters

[github/wallabag/wallabag.git] / inc / 3rdparty / libraries / simplepie / library / SimplePie / Author.php

diff --git a/inc/3rdparty/simplepie/SimplePie/Author.php b/inc/3rdparty/libraries/simplepie/library/SimplePie/Author.php
similarity index 72%
rename from inc/3rdparty/simplepie/SimplePie/Author.php
rename to inc/3rdparty/libraries/simplepie/library/SimplePie/Author.php
index 77e5dc58b61d9bef093d44d0f09baade28da03a3..bbf3812ff88b82555fb9dba5c88392757854929c 100644 (file)
--- a/inc/3rdparty/simplepie/SimplePie/Author.php
+++ b/inc/3rdparty/libraries/simplepie/library/SimplePie/Author.php
@@ -5,7 +5,7 @@
  * A PHP-Based RSS and Atom Feed Framework.
  * Takes the hard work out of managing a complete RSS/Atom solution.
  *
- * Copyright (c) 2004-2009, Ryan Parman, Geoffrey Sneddon, Ryan McCue, and contributors
+ * Copyright (c) 2004-2012, Ryan Parman, Geoffrey Sneddon, Ryan McCue, and contributors
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without modification, are
@@ -33,24 +33,58 @@
  * POSSIBILITY OF SUCH DAMAGE.
  *
  * @package SimplePie
- * @version 1.3-dev
- * @copyright 2004-2010 Ryan Parman, Geoffrey Sneddon, Ryan McCue
+ * @version 1.3.1
+ * @copyright 2004-2012 Ryan Parman, Geoffrey Sneddon, Ryan McCue
  * @author Ryan Parman
  * @author Geoffrey Sneddon
  * @author Ryan McCue
  * @link http://simplepie.org/ SimplePie
  * @license http://www.opensource.org/licenses/bsd-license.php BSD License
- * @todo phpDoc comments
  */
 
-
+/**
+ * Manages all author-related data
+ *
+ * Used by {@see SimplePie_Item::get_author()} and {@see SimplePie::get_authors()}
+ *
+ * This class can be overloaded with {@see SimplePie::set_author_class()}
+ *
+ * @package SimplePie
+ * @subpackage API
+ */
 class SimplePie_Author
 {
+       /**
+        * Author's name
+        *
+        * @var string
+        * @see get_name()
+        */
        var $name;
+
+       /**
+        * Author's link
+        *
+        * @var string
+        * @see get_link()
+        */
        var $link;
+
+       /**
+        * Author's email address
+        *
+        * @var string
+        * @see get_email()
+        */
        var $email;
 
-       // Constructor, used to input the data
+       /**
+        * Constructor, used to input the data
+        *
+        * @param string $name
+        * @param string $link
+        * @param string $email
+        */
        public function __construct($name = null, $link = null, $email = null)
        {
                $this->name = $name;
@@ -58,12 +92,22 @@ class SimplePie_Author
                $this->email = $email;
        }
 
+       /**
+        * String-ified version
+        *
+        * @return string
+        */
        public function __toString()
        {
                // There is no $this->data here
                return md5(serialize($this));
        }
 
+       /**
+        * Author's name
+        *
+        * @return string|null
+        */
        public function get_name()
        {
                if ($this->name !== null)
@@ -76,6 +120,11 @@ class SimplePie_Author
                }
        }
 
+       /**
+        * Author's link
+        *
+        * @return string|null
+        */
        public function get_link()
        {
                if ($this->link !== null)
@@ -88,6 +137,11 @@ class SimplePie_Author
                }
        }
 
+       /**
+        * Author's email address
+        *
+        * @return string|null
+        */
        public function get_email()
        {
                if ($this->email !== null)