From 98d13c25aa96f85a46360cf61f3dec0872ea8b8d Mon Sep 17 00:00:00 2001 From: vargenau Date: Tue, 28 Jan 2014 17:10:36 +0000 Subject: [PATCH] Update PHP Doc git-svn-id: svn://svn.code.sf.net/p/phpwiki/code/trunk@8850 96ab9672-09ca-45d6-a79d-3d69d39ca109 --- lib/PageList.php | 2 +- lib/WikiDB.php | 30 +++++++++++++++--------------- lib/WikiPluginCached.php | 10 +++++----- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/lib/PageList.php b/lib/PageList.php index 06a1ff0f3..d3695815f 100644 --- a/lib/PageList.php +++ b/lib/PageList.php @@ -1326,7 +1326,7 @@ class PageList * 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) diff --git a/lib/WikiDB.php b/lib/WikiDB.php index 3c3010d93..628341145 100644 --- a/lib/WikiDB.php +++ b/lib/WikiDB.php @@ -273,15 +273,15 @@ class WikiDB * * @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 @@ class WikiDB * * @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 @@ class WikiDB * @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 @@ class WikiDB * * @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 @@ class WikiDB /** * @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 @@ class WikiDB_Page /** * @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. diff --git a/lib/WikiPluginCached.php b/lib/WikiPluginCached.php index 069b552d5..a25695518 100644 --- a/lib/WikiPluginCached.php +++ b/lib/WikiPluginCached.php @@ -126,11 +126,11 @@ class WikiPluginCached extends WikiPlugin * however. * * @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 -- 2.42.0