From 42ea7f447f39fbc2f79eaaec31f8c10ede59c5d0 Mon Sep 17 00:00:00 2001
From: Gerrit Uitslag <klapinklapin@gmail.com>
Date: Wed, 1 Oct 2014 11:30:27 +0200
Subject: Many PHPDocs, some unused and dyn declared vars

many PHPDocs
some unused variables
some dynamically declared variables declared
---
 inc/cli.php | 23 ++++++++++++++---------
 1 file changed, 14 insertions(+), 9 deletions(-)

(limited to 'inc/cli.php')

diff --git a/inc/cli.php b/inc/cli.php
index 25bfddf7d..29d76ece1 100644
--- a/inc/cli.php
+++ b/inc/cli.php
@@ -108,7 +108,7 @@ abstract class DokuCLI {
     /**
      * Print an error message
      *
-     * @param $string
+     * @param string $string
      */
     public function error($string) {
         $this->colors->ptln("E: $string", 'red', STDERR);
@@ -117,7 +117,7 @@ abstract class DokuCLI {
     /**
      * Print a success message
      *
-     * @param $string
+     * @param string $string
      */
     public function success($string) {
         $this->colors->ptln("S: $string", 'green', STDERR);
@@ -126,7 +126,7 @@ abstract class DokuCLI {
     /**
      * Print an info message
      *
-     * @param $string
+     * @param string $string
      */
     public function info($string) {
         $this->colors->ptln("I: $string", 'cyan', STDERR);
@@ -199,8 +199,8 @@ class DokuCLI_Colors {
     /**
      * Convenience function to print a line in a given color
      *
-     * @param          $line
-     * @param          $color
+     * @param string   $line
+     * @param string   $color
      * @param resource $channel
      */
     public function ptln($line, $color, $channel = STDOUT) {
@@ -470,8 +470,8 @@ class DokuCLI_Options {
      * Can only be used after parseOptions() has been run
      *
      * @param string $option
-     * @param mixed  $default what to return if the option was not set
-     * @return mixed
+     * @param bool|string $default what to return if the option was not set
+     * @return false|string
      */
     public function getOpt($option, $default = false) {
         if(isset($this->options[$option])) return $this->options[$option];
@@ -593,8 +593,8 @@ class DokuCLI_Options {
     /**
      * Displays text in multiple word wrapped columns
      *
-     * @param array $widths list of column widths (in characters)
-     * @param array $texts  list of texts for each column
+     * @param int[]    $widths list of column widths (in characters)
+     * @param string[] $texts  list of texts for each column
      * @return string
      */
     private function tableFormat($widths, $texts) {
@@ -640,6 +640,11 @@ class DokuCLI_Exception extends Exception {
     const E_OPT_ABIGUOUS = 4; //Option abiguous
     const E_ARG_READ = 5; //Could not read argv
 
+    /**
+     * @param string    $message     The Exception message to throw.
+     * @param int       $code        The Exception code
+     * @param Exception $previous    The previous exception used for the exception chaining.
+     */
     public function __construct($message = "", $code = 0, Exception $previous = null) {
         if(!$code) $code = DokuCLI_Exception::E_ANY;
         parent::__construct($message, $code, $previous);
-- 
cgit v1.2.3