mambax7 / planet

class/article.php

Doc Comments -1 removed lines

@@ -109,7 +109,6 @@
     /**
      * get summary of the article
      * 
-     * @param bool 	$actionOnEmpty flag for truncating content if summary is empty
      * @return string
      */
     function &getSummary($length = 0)

class/class-IXR.php

Doc Comments +11 added lines

@@ -650,6 +650,10 @@ 
 
 class IXR_Base64 {
     var $data;
+
+    /**
+     * @param string $data
+     */
     function IXR_Base64($data) {
         $this->data = $data;
     }
@@ -694,6 +698,13 @@ 
             'Returns a documentation string for the specified method'
         );
     }
+
+    /**
+     * @param string $method
+     * @param string $callback
+     * @param string[] $args
+     * @param string $help
+     */
     function addCallback($method, $callback, $args, $help) {
         $this->callbacks[$method] = $callback;
         $this->signatures[$method] = $args;

class/feedcreator.class.php

Doc Comments +9 added lines, -2 removed lines

@@ -359,6 +359,9 @@ 
 class UniversalFeedCreator extends FeedCreator {
 	var $_feed;
 
+	/**
+	 * @param string $format
+	 */
 	function _setFormat($format) {
 		switch (strtoupper($format)) {
 
@@ -540,6 +543,7 @@ 
 	 * Adds an FeedItem to the feed.
 	 *
 	 * @param object FeedItem $item The FeedItem to add to the feed.
+	 * @param FeedItem $item
 	 * @access public
 	 */
 	function addItem($item) {
@@ -557,6 +561,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
 	 */
 	function iTrunc($string, $length) {
@@ -655,6 +660,7 @@ 
 	/**
 	 * @since 1.4
 	 * @access private
+	 * @param string $filename
 	 */
 	function _redirect($filename) {
 		// attention, heavily-commented-out-area
@@ -788,7 +794,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
 	 */
 	function rfc822() {
 		//return gmdate("r",$this->unix);
@@ -800,7 +806,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
 	 */
 	function iso8601() {
 		$date = gmdate("Y-m-d\TH:i:sO",$this->unix);
@@ -922,6 +928,7 @@ 
 	/**
 	 * Sets this RSS feed's version number.
 	 * @access private
+	 * @param string $version
 	 */
 	function _setRSSVersion($version) {
 		$this->RSSVersion = $version;

class/magpie.inc.php

Doc Comments +7 added lines

@@ -450,6 +450,10 @@ 
     /**
     * return XML parser, and possibly re-encoded source
     *
+    * @param string $source
+    * @param string $out_enc
+    * @param string|null $in_enc
+    * @param boolean $detect
     */
     function create_parser($source, $out_enc, $in_enc, $detect) {
         if ( substr(phpversion(),0,1) == 5) {
@@ -561,6 +565,9 @@ 
         }
     }
 
+    /**
+     * @param integer $lvl
+     */
     function error ($errormsg, $lvl=E_USER_WARNING) {
         // append PHP's error message if track_errors enabled
         if ( !empty($php_errormsg) ) {

class/xml.php

Doc Comments +4 added lines

@@ -93,6 +93,10 @@
         $this->version = $version;
     }
 
+    /**
+     * @param string $var
+     * @param FeedImage $val
+     */
     function setVar($var, $val, $encoding = false)
     {
 	    if(!empty($encoding)) $val = $this->convert_encoding($val);

class/xmlparser.php

Doc Comments -7 removed lines

@@ -53,13 +53,6 @@
      *  @param string $content           string containing the RSS to be parsed
      *
      *
-     *  @param string $output_encoding  output the parsed RSS in this character
-     *                                  set defaults to ISO-8859-1 as this is PHP's
-     *                                  default.
-     *
-     *  @param string $input_encoding   the character set of the incoming RSS source.
-     *                                  Leave blank and Magpie will try to figure it
-     *                                  out.
      *
      */
     function XmlParser ($content, $input_charset, $output_charset = _CHARSET, $tags = array())

include/functions.ini.php

Doc Comments +6 added lines

@@ -37,11 +37,17 @@
 if(!defined("PLANET_FUNCTIONS_INI")):
 define("PLANET_FUNCTIONS_INI",1);
 
+/**
+ * @param string $name
+ */
 function planet_constant($name)
 {
 	return mod_constant($name);
 }
 
+/**
+ * @param string $name
+ */
 function planet_DB_prefix($name, $isRel = false)
 {
 	return mod_DB_prefix($name, $isRel);

include/functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -98,7 +98,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="")
 {
@@ -131,7 +131,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="")
 {