[phpwiki-checkins] SF.net SVN: phpwiki:[8850] trunk/lib

[<var...@us...>]

Revision: 8850
          http://sourceforge.net/p/phpwiki/code/8850
Author:   vargenau
Date:     2014-01-28 17:10:36 +0000 (Tue, 28 Jan 2014)
Log Message:
-----------
Update PHP Doc

Modified Paths:
--------------
    trunk/lib/PageList.php
    trunk/lib/WikiDB.php
    trunk/lib/WikiPluginCached.php

Modified: trunk/lib/PageList.php
===================================================================
--- trunk/lib/PageList.php	2014-01-28 17:09:51 UTC (rev 8849)
+++ trunk/lib/PageList.php	2014-01-28 17:10:36 UTC (rev 8850)
@@ -1326,7 +1326,7 @@
      * column will only be added the first time, and ignored the succeeding times.
      * If you wish to add multiple columns of the same type, use addColumnObject().
      *
-     * @param string column name
+     * @param string $column column name
      * @return bool true if column is added, false otherwise
      */
     function _addColumn($column)

Modified: trunk/lib/WikiDB.php
===================================================================
--- trunk/lib/WikiDB.php	2014-01-28 17:09:51 UTC (rev 8849)
+++ trunk/lib/WikiDB.php	2014-01-28 17:10:36 UTC (rev 8850)
@@ -273,15 +273,15 @@
      *
      * @access public
      *
-     * @param boolean $include_empty Optional. Normally pages whose most
+     * @param bool $include_empty Optional. Normally pages whose most
      * recent revision has empty content are considered to be
      * non-existant. Unless $include_defaulted is set to true, those
      * pages will not be returned.
-     * @param string or false $sortby Optional. "+-column,+-column2".
+     * @param string $sortby Optional. "+-column,+-column2".
      *        If false the result is faster in natural order.
-     * @param string or false $limit Optional. Encoded as "$offset,$count".
+     * @param string $limit Optional. Encoded as "$offset,$count".
      *         $offset defaults to 0.
-     * @param string $exclude: Optional comma-separated list of pagenames.
+     * @param string $exclude  Optional comma-separated list of pagenames.
      *
      * @return WikiDB_PageIterator A WikiDB_PageIterator which contains all pages
      *     in the WikiDB which have non-default contents.
@@ -332,11 +332,11 @@
      *
      * @access public
      * @param TextSearchQuery $search A TextSearchQuery object
-     * @param string or false $sortby Optional. "+-column,+-column2".
+     * @param string $sortby Optional. "+-column,+-column2".
      *        If false the result is faster in natural order.
-     * @param string or false $limit Optional. Encoded as "$offset,$count".
+     * @param string $limit Optional. Encoded as "$offset,$count".
      *         $offset defaults to 0.
-     * @param  string              $exclude: Optional comma-separated list of pagenames.
+     * @param  string $exclude Optional comma-separated list of pagenames.
      * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
      * @see TextSearchQuery
      */
@@ -363,11 +363,11 @@
      * @access public
      *
      * @param TextSearchQuery $search A TextSearchQuery object.
-     * @param string or false $sortby Optional. "+-column,+-column2".
+     * @param string $sortby Optional. "+-column,+-column2".
      *        If false the result is faster in natural order.
-     * @param string or false $limit Optional. Encoded as "$offset,$count".
+     * @param string $limit Optional. Encoded as "$offset,$count".
      *         $offset defaults to 0.
-     * @param  string              $exclude: Optional comma-separated list of pagenames.
+     * @param  string $exclude Optional comma-separated list of pagenames.
      * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
      * @see TextSearchQuery
      */
@@ -388,10 +388,10 @@
      *
      * @access public
      *
-     * @param integer $limit The maximum number of pages to return.
+     * @param int $limit The maximum number of pages to return.
      * Set $limit to zero to return all pages.  If $limit < 0, pages will
      * be sorted in decreasing order of popularity.
-     * @param string or false $sortby Optional. "+-column,+-column2".
+     * @param string $sortby Optional. "+-column,+-column2".
      *        If false the result is faster in natural order.
      *
      * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching
@@ -441,9 +441,9 @@
     /**
      * @access public
      *
-     * @param string or false $sortby Optional. "+-column,+-column2".
+     * @param string $sortby Optional. "+-column,+-column2".
      *        If false the result is faster in natural order.
-     * @param string or false $limit Optional. Encoded as "$offset,$count".
+     * @param string $limit Optional. Encoded as "$offset,$count".
      *         $offset defaults to 0.
      * @return Iterator A generic iterator containing rows of
      *         (duplicate) pagename, wantedfrom.
@@ -1460,7 +1460,7 @@
 
     /**
      * @access private
-     * @param integer_or_object $version_or_pagerevision
+     * @param int|object $version_or_pagerevision
      * Takes either the version number (and int) or a WikiDB_PageRevision
      * object.
      * @return integer The version number.

Modified: trunk/lib/WikiPluginCached.php
===================================================================
--- trunk/lib/WikiPluginCached.php	2014-01-28 17:09:51 UTC (rev 8849)
+++ trunk/lib/WikiPluginCached.php	2014-01-28 17:10:36 UTC (rev 8850)
@@ -126,11 +126,11 @@
      * however. </b>
      *
      * @access protected
-     * @param  dbi       WikiDB  database abstraction class
-     * @param  argstr    string  plugin arguments in the call from PhpWiki
-     * @param  request   Request ???
-     * @param  string    basepage Pagename to use to interpret links [/relative] page names.
-     * @return string HTML output to be printed to browser
+     * @param  WikiDB  $dbi      database abstraction class
+     * @param  string  $argstr   plugin arguments in the call from PhpWiki
+     * @param  Request $request
+     * @param  string  $basepage Pagename to use to interpret links [/relative] page names.
+     * @return string            HTML output to be printed to browser
      *
      * @see #getHtml
      * @see #getImage

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.