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

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

Revision: 9300
          http://sourceforge.net/p/phpwiki/code/9300
Author:   vargenau
Date:     2014-11-09 20:00:47 +0000 (Sun, 09 Nov 2014)
Log Message:
-----------
PHP Doc

Modified Paths:
--------------
    trunk/lib/AccessLog.php
    trunk/lib/FileFinder.php
    trunk/lib/HtmlElement.php
    trunk/lib/IniConfig.php
    trunk/lib/Template.php

Modified: trunk/lib/AccessLog.php
===================================================================
--- trunk/lib/AccessLog.php	2014-11-09 19:54:52 UTC (rev 9299)
+++ trunk/lib/AccessLog.php	2014-11-09 20:00:47 UTC (rev 9300)
@@ -107,7 +107,11 @@
     }
 
     /**
-     * Return iterator of referer items reverse sorted (latest first).
+     * Return iterator of referrer items reverse sorted (latest first).
+     *
+     * @param int $limit
+     * @param bool $external_only
+     * @return WikiDB_Array_generic_iter
      */
     function get_referer($limit = 15, $external_only = false)
     {

Modified: trunk/lib/FileFinder.php
===================================================================
--- trunk/lib/FileFinder.php	2014-11-09 19:54:52 UTC (rev 9299)
+++ trunk/lib/FileFinder.php	2014-11-09 20:00:47 UTC (rev 9300)
@@ -48,6 +48,9 @@
      * Unify used pathsep character.
      * Accepts array of paths also.
      * This might not work on Windows95 or FAT volumes. (not tested)
+     *
+     * @param string $path
+     * @return mixed|string
      */
     function slashifyPath($path)
     {
@@ -56,6 +59,10 @@
 
     /**
      * Force using '/' as path seperator.
+     *
+     * @param string $path
+     * @param string $sep
+     * @return mixed|string
      */
     function forcePathSlashes($path, $sep = '/')
     {
@@ -89,7 +96,7 @@
      * to PHP's include_path (if it's not already there.) Then the
      * file is include_once()'d.
      *
-     * @param $file string File to include.
+     * @param string $file File to include.
      * @return bool True if file was successfully included.
      */
     function includeOnce($file)

Modified: trunk/lib/HtmlElement.php
===================================================================
--- trunk/lib/HtmlElement.php	2014-11-09 19:54:52 UTC (rev 9299)
+++ trunk/lib/HtmlElement.php	2014-11-09 20:00:47 UTC (rev 9300)
@@ -48,6 +48,9 @@
 
     /**
      * This is used by the static factory methods is class HTML.
+     *
+     * @param array $args
+     * @return $this
      */
     protected function _init2($args)
     {

Modified: trunk/lib/IniConfig.php
===================================================================
--- trunk/lib/IniConfig.php	2014-11-09 19:54:52 UTC (rev 9299)
+++ trunk/lib/IniConfig.php	2014-11-09 20:00:47 UTC (rev 9300)
@@ -68,6 +68,8 @@
  * Dump the static parts of the parsed config/config.ini settings to a fast-loadable config.php file.
  * The dynamic parts are then evaluated as before.
  * Requires write-permissions to config/config.php
+ *
+ * @param string $file
  */
 function save_dump($file)
 {

Modified: trunk/lib/Template.php
===================================================================
--- trunk/lib/Template.php	2014-11-09 19:54:52 UTC (rev 9299)
+++ trunk/lib/Template.php	2014-11-09 20:00:47 UTC (rev 9300)
@@ -8,6 +8,10 @@
 {
     /**
      * name optionally of form "theme/template" to include parent templates in children
+     *
+     * @param string $name
+     * @param WikiRequest $request
+     * @param array $args
      */
     function Template($name, &$request, $args = array())
     {
@@ -247,8 +251,6 @@
  * @param string $title page title
  * @param object|bool $page_revision A WikiDB_PageRevision object or false
  * @param array $args hash Extract args for top-level template
- *
- * @return string HTML expansion of template.
  */
 function GeneratePage($content, $title, $page_revision = false, $args = array())
 {

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