Menu
▾
▴
[phpwiki-checkins] SF.net SVN: phpwiki:[8401] trunk/lib/plugin
|
From: <var...@us...> - 2012-10-08 23:19:17
|
Revision: 8401
http://phpwiki.svn.sourceforge.net/phpwiki/?rev=8401&view=rev
Author: vargenau
Date: 2012-10-08 23:19:11 +0000 (Mon, 08 Oct 2012)
Log Message:
-----------
Fix Phpdoc
Modified Paths:
--------------
trunk/lib/plugin/FoafViewer.php
trunk/lib/plugin/GraphViz.php
trunk/lib/plugin/PhotoAlbum.php
trunk/lib/plugin/Ploticus.php
trunk/lib/plugin/PopularNearby.php
trunk/lib/plugin/RateIt.php
trunk/lib/plugin/RecentChanges.php
trunk/lib/plugin/VisualWiki.php
Modified: trunk/lib/plugin/FoafViewer.php
===================================================================
--- trunk/lib/plugin/FoafViewer.php 2012-10-08 09:07:20 UTC (rev 8400)
+++ trunk/lib/plugin/FoafViewer.php 2012-10-08 23:19:11 UTC (rev 8401)
@@ -194,6 +194,8 @@
*
* @param $array Source array
* @param $index Element Index to use.
+ * @param null $dc
+ * @return \RawXml
* @todo Make sure it can look more than 1 layer deep
* @todo Pass in dublincore metadata
*/
Modified: trunk/lib/plugin/GraphViz.php
===================================================================
--- trunk/lib/plugin/GraphViz.php 2012-10-08 09:07:20 UTC (rev 8400)
+++ trunk/lib/plugin/GraphViz.php 2012-10-08 23:19:11 UTC (rev 8401)
@@ -159,6 +159,9 @@
* Sets the imagetype according to user wishes and
* relies on WikiPluginCached to catch illegal image
* formats.
+ * @param WikiDB $dbi
+ * @param array $argarray
+ * @param Request $request
* @return string 'png', 'jpeg', 'gif'
*/
function getImageType($dbi, $argarray, $request)
@@ -352,6 +355,7 @@
* 'none')
* @param shape string node shape; 'ellipse', 'box', 'circle', 'point'
* @param label string not used anymore
+ * @return array
*/
function invokeDot($argarray)
{
Modified: trunk/lib/plugin/PhotoAlbum.php
===================================================================
--- trunk/lib/plugin/PhotoAlbum.php 2012-10-08 09:07:20 UTC (rev 8400)
+++ trunk/lib/plugin/PhotoAlbum.php 2012-10-08 23:19:11 UTC (rev 8401)
@@ -555,6 +555,7 @@
*
* @param string $src path to dir or textfile (local or remote)
* @param array $photos
+ * @param string $webpath
* @return string Error when bad url or file couldn't be opened
*/
function fromFile($src, &$photos, $webpath = '')
Modified: trunk/lib/plugin/Ploticus.php
===================================================================
--- trunk/lib/plugin/Ploticus.php 2012-10-08 09:07:20 UTC (rev 8400)
+++ trunk/lib/plugin/Ploticus.php 2012-10-08 23:19:11 UTC (rev 8401)
@@ -142,6 +142,9 @@
* this case, because png will definitely have the
* best results.)
*
+ * @param WikiDB $dbi
+ * @param array $argarray
+ * @param Request $request
* @return string 'png', 'jpeg', 'gif'
*/
function getImageType($dbi, $argarray, $request)
Modified: trunk/lib/plugin/PopularNearby.php
===================================================================
--- trunk/lib/plugin/PopularNearby.php 2012-10-08 09:07:20 UTC (rev 8400)
+++ trunk/lib/plugin/PopularNearby.php 2012-10-08 23:19:11 UTC (rev 8401)
@@ -105,6 +105,7 @@
* @param $pages array of WikiDB_Page's or a Page_iterator
* @param $direction boolean: true if incoming links
*
+ * @param int $limit
* @return Array of sorted links
*/
function sortedLinks($pages, $direction = false, $limit = 5)
Modified: trunk/lib/plugin/RateIt.php
===================================================================
--- trunk/lib/plugin/RateIt.php 2012-10-08 09:07:20 UTC (rev 8400)
+++ trunk/lib/plugin/RateIt.php 2012-10-08 23:19:11 UTC (rev 8401)
@@ -309,13 +309,18 @@
*
* This needs to be put in the <body> section of the page.
*
- * @param pagename Name of the page to rate
+ * @param Name $pagename
* @param version Version of the page to rate (may be "" for current)
- * @param imgPrefix Prefix of the names of the images that display the rating
+ * @param Prefix $imgPrefix
+ * @param Id $dimension
+ * @param bool|Makes $small
+ * @return \HtmlElement
+ * @internal param \Name $pagename of the page to rate
+ * @internal param \Prefix $imgPrefix of the names of the images that display the rating
* You can have two widgets for the same page displayed at
* once iff the imgPrefix-s are different.
- * @param dimension Id of the dimension to rate
- * @param small Makes a smaller ratings widget if non-false
+ * @internal param \Id $dimension of the dimension to rate
+ * @internal param \Makes $small a smaller ratings widget if non-false
*
* Limitations: Currently this can only print the current users ratings.
* And only the widget, but no value (for buddies) also.
Modified: trunk/lib/plugin/RecentChanges.php
===================================================================
--- trunk/lib/plugin/RecentChanges.php 2012-10-08 09:07:20 UTC (rev 8400)
+++ trunk/lib/plugin/RecentChanges.php 2012-10-08 23:19:11 UTC (rev 8401)
@@ -1108,6 +1108,8 @@
/** Constructor
*
* @param $revisions object a WikiDB_PageRevisionIterator.
+ * @param bool $check_current_revision
+ * @return void
*/
function NonDeletedRevisionIterator($revisions, $check_current_revision = true)
{
Modified: trunk/lib/plugin/VisualWiki.php
===================================================================
--- trunk/lib/plugin/VisualWiki.php 2012-10-08 09:07:20 UTC (rev 8400)
+++ trunk/lib/plugin/VisualWiki.php 2012-10-08 23:19:11 UTC (rev 8401)
@@ -150,6 +150,9 @@
/**
* Checks options, creates help page if necessary, calls both
* database access and image map production functions.
+ * @param WikiDB $dbi
+ * @param array $argarray
+ * @param Request $request
* @return array($map,$html)
*/
function getMap($dbi, $argarray, $request)
@@ -221,10 +224,13 @@
* Selects the first (smallest or biggest) WikiPages in
* a given category.
*
- * @param number integer number of page names to be found
- * @param category string attribute of the pages which is used
+ * @param int $number
+ * @param string $category
+ * @param bool $minimum
+ * @internal param int $number number of page names to be found
+ * @internal param string $category attribute of the pages which is used
* to compare them
- * @param minimum boolean true finds smallest, false finds biggest
+ * @internal param bool $minimum true finds smallest, false finds biggest
* @return array list of page names found to be the best
*/
function findbest($number, $category, $minimum)
@@ -273,20 +279,22 @@
* like size, age, revision number which are used to find the
* most attractive pages.
*
- * @param dbi WikiDB database handle to access all Wiki pages
- * @param LARGE integer number of largest pages which should
+ * @param WikiDB $dbi
+ * @param $argarray
+ * @internal param \WikiDB $dbi database handle to access all Wiki pages
+ * @internal param int $LARGE number of largest pages which should
* be included
- * @param RECENT integer number of the youngest pages to be included
- * @param REFINED integer number of the pages with shortes revision
+ * @internal param int $RECENT number of the youngest pages to be included
+ * @internal param int $REFINED number of the pages with shortes revision
* interval
- * @param BACKLINK integer number of the pages with most backlinks
- * @param EXCLUDELIST string colon ':' separated list of page names which
+ * @internal param int $BACKLINK number of the pages with most backlinks
+ * @internal param string $EXCLUDELIST colon ':' separated list of page names which
* should not be displayed (like PhpWiki, for
* example)
- * @param INCLUDELIST string colon separated list of pages which are
+ * @internal param string $INCLUDELIST colon separated list of pages which are
* always included (for example your own
* page :)
- * @param COLOR string 'age', 'revtime' or 'none'; Selects which
+ * @internal param string $COLOR 'age', 'revtime' or 'none'; Selects which
* page feature is used to determine the
* filling color of the nodes in the graph.
* @return void
@@ -417,13 +425,15 @@
* Creates the text file description of the graph needed to invoke
* <code>dot</code>.
*
- * @param filename string name of the dot file to be created
- * @param width float width of the output graph in inches
- * @param height float height of the graph in inches
- * @param colorby string color sceme beeing used ('age', 'revtime',
+ * @param string $filename
+ * @param bool $argarray
+ * @internal param string $filename name of the dot file to be created
+ * @internal param float $width width of the output graph in inches
+ * @internal param float $height height of the graph in inches
+ * @internal param string $colorby color sceme beeing used ('age', 'revtime',
* 'none')
- * @param shape string node shape; 'ellipse', 'box', 'circle', 'point'
- * @param label string 'name': label by name,
+ * @internal param string $shape node shape; 'ellipse', 'box', 'circle', 'point'
+ * @internal param string $label 'name': label by name,
* 'number': label by unique number
* @return boolean error status; true=ok; false=error
*/
@@ -534,14 +544,17 @@
* called only if debug=static.
*
* @access private
- * @param url string url pointing to the image part of the map
- * @param map string <area> tags defining active
+ * @param string $url
+ * @param WikiDB $dbi
+ * @param array $argarray
+ * @param request Request ???
+ * @internal param string $url url pointing to the image part of the map
+ * @internal param string $map <area> tags defining active
* regions in the map
- * @param dbi WikiDB database abstraction class
- * @param argarray array complete (!) arguments to produce
+ * @internal param \WikiDB $dbi database abstraction class
+ * @internal param array $argarray complete (!) arguments to produce
* image. It is not necessary to call
* WikiPlugin->getArgs anymore.
- * @param request Request ???
* @return string html output
*/
function embedImg($url, &$dbi, $argarray, &$request)
@@ -606,7 +619,8 @@
* Translates a value from 0.0 to 1.0 into rainbow color.
* red -> orange -> green -> blue -> gray
*
- * @param promille float value between 0.0 and 1.0
+ * @param float $promille
+ * @internal param float $promille value between 0.0 and 1.0
* @return array(red,green,blue)
*/
function getColor($promille)
@@ -623,6 +637,9 @@
/**
* Linear interpolates a value between two point a and b
* at a value pos.
+ * @param $a
+ * @param $b
+ * @param $pos
* @return float interpolated value
*/
function interpolate($a, $b, $pos)
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
