mambax7 / planet

class/class-IXR.php

Doc Comments +6 added lines, -6 removed lines

@@ -166,7 +166,7 @@ 
 
     /**
      * IXR_Message constructor.
-     * @param $message
+     * @param string|boolean $message
      */
     public function __construct($message) {
         $this->message = $message;
@@ -863,7 +863,7 @@ 
 
     /**
      * IXR_Base64 constructor.
-     * @param $data
+     * @param string $data
      */
     public function __construct($data) {
         $this->data = $data;
@@ -906,10 +906,10 @@ 
     }
 
     /**
-     * @param $method
-     * @param $callback
-     * @param $args
-     * @param $help
+     * @param string $method
+     * @param string $callback
+     * @param string[] $args
+     * @param string $help
      */
     public function addCallback($method, $callback, $args, $help) {
         $this->callbacks[$method]  = $callback;

class/feedcreator.class.php

Doc Comments +7 added lines, -6 removed lines

@@ -352,7 +352,7 @@ 
     public $_feed;
 
     /**
-     * @param $format
+     * @param string $format
      */
     public function _setFormat($format) {
         switch (strtoupper($format)) {
@@ -529,7 +529,7 @@ 
     /**
      * Adds an FeedItem to the feed.
      *
-     * @param $item
+     * @param FeedItem $item
      * @internal param FeedItem $object $item The FeedItem to add to the feed.
      * @access   public
      */
@@ -547,6 +547,7 @@ 
      * @static
      * @param string     string A string to be truncated.
      * @param int        length the maximum length the string should be truncated to
+     * @param integer $length
      * @return string the truncated string
      */
     public function iTrunc($string, $length) {
@@ -652,7 +653,7 @@ 
     /**
      * @since  1.4
      * @access private
-     * @param $filename
+     * @param string $filename
      */
     public function _redirect($filename) {
         // attention, heavily-commented-out-area
@@ -807,7 +808,7 @@ 
     /**
      * Gets the date stored in this FeedDate as an RFC 822 date.
      *
-     * @return a date in RFC 822 format
+     * @return string date in RFC 822 format
      */
     public function rfc822() {
         //return gmdate("r",$this->unix);
@@ -822,7 +823,7 @@ 
     /**
      * Gets the date stored in this FeedDate as an ISO 8601 date.
      *
-     * @return a date in ISO 8601 format
+     * @return string date in ISO 8601 format
      */
     public function iso8601() {
         $date = gmdate("Y-m-d\TH:i:sO", $this->unix);
@@ -949,7 +950,7 @@ 
     /**
      * Sets this RSS feed's version number.
      * @access private
-     * @param $version
+     * @param string $version
      */
     public function _setRSSVersion($version) {
         $this->RSSVersion = $version;

class/magpie.inc.php

Doc Comments +8 added lines, -8 removed lines

@@ -302,7 +302,7 @@ 
 
     // smart append - field and namespace aware
     /**
-     * @param $el
+     * @param string $el
      * @param $text
      */
     public function append($el, $text) {
@@ -384,7 +384,7 @@ 
     }
 
     /**
-     * @return bool
+     * @return string|false
      */
     public function is_rss() {
         if ($this->feed_type == RSS) {
@@ -395,7 +395,7 @@ 
     }
 
     /**
-     * @return bool
+     * @return string|false
      */
     public function is_atom() {
         if ($this->feed_type == ATOM) {
@@ -407,10 +407,10 @@ 
 
     /**
      * return XML parser, and possibly re-encoded source
-     * @param $source
-     * @param $out_enc
-     * @param $in_enc
-     * @param $detect
+     * @param string $source
+     * @param string $out_enc
+     * @param string|null $in_enc
+     * @param boolean $detect
      * @return array
      */
     public function create_parser($source, $out_enc, $in_enc, $detect) {
@@ -517,7 +517,7 @@ 
 
     /**
      * @param $enc
-     * @return bool|string
+     * @return string|false
      */
     public function known_encoding($enc) {
         $enc = strtoupper($enc);

class/xmlparser.php

Doc Comments +1 added lines, -1 removed lines

@@ -83,7 +83,7 @@
     }
 
     /**
-     * @return bool|string
+     * @return string|false
      */
     public function is_atom() {
         if ($this->feed_type == ATOM) {

include/functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -108,7 +108,7 @@ 
      * @var mixed  $pattern
      * @var mixed  $replacement
      *
-     * @return bool true on success
+     * @return null|boolean true on success
      */
     function planet_parse_class($class_string, $pattern = '', $replacement = '') {
         if (empty($class_string)) {
@@ -143,7 +143,7 @@ 
      * @var mixed  $pattern
      * @var mixed  $replacement
      *
-     * @return bool true on success
+     * @return null|boolean true on success
      */
     function planet_parse_function($function_string, $pattern = '', $replacement = '') {
         if (empty($function_string)) {
@@ -494,7 +494,7 @@ 
 
     /**
      * @param $url
-     * @return bool|string
+     * @return false|string
      */
     function planet_fetch_fopen($url) {
         if (!$fp = @fopen($url, 'r')) {

view.archive.php

Doc Comments +1 added lines, -1 removed lines

@@ -293,7 +293,7 @@
 // Used in get_calendar
 /**
  * @param $num
- * @return mixed
+ * @return double
  */
 function planet_calendar_week_mod($num) {
     $base = 7;