dwoo-project / dwoo

lib/Dwoo/Adapters/CodeIgniter/libraries/Dwootemplate.php

Doc Comments +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
      *
      * @param string $sTemplate
      * @param boolean $return
-     * @return mixed
+     * @return null|string
      */
     public function display($sTemplate, $return = FALSE) {
         // Start benchmark

lib/Dwoo/Adapters/ZendFramework/PluginProxy.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
 	/**
 	 * Dwoo_Adapters_ZendFramework_PluginProxy's constructor.
 	 *
-	 * @param Zend_View_Interface $view
+	 * @param Dwoo_Adapters_ZendFramework_View $view
 	 */
 	public function __construct(Zend_View_Interface $view) {
 		$this->view = $view;

lib/Dwoo/Adapters/ZendFramework/View.php

Doc Comments +3 added lines, -4 removed lines

@@ -87,7 +87,6 @@ 
 	 *  - type class name or object for engine, dataProvider or compiler
 	 *  - any set* method (compileDir for setCompileDir ...)
 	 *
-	 * @param  array $options
 	 * @return Dwoo_Adapters_ZendFramework_View
 	 */
 	public function setOptions(array $opt = array())
@@ -272,6 +271,7 @@ 
 	 * Sets Dwoo data object
 	 *
 	 * @param string|Dwoo_Data Object or name of the class
+	 * @param Dwoo_Data $data
 	 */
 	public function setDataProvider($data)
 	{
@@ -329,7 +329,7 @@ 
 	/**
 	 * Return the Dwoo compiler object
 	 *
-	 * @return Dwoo_Data
+	 * @return Dwoo_Compiler
 	 */
 	public function getCompiler()
 	{
@@ -404,7 +404,7 @@ 
 	 * Clears all variables assigned to Zend_View either via {@link assign()} or
 	 * property overloading ({@link __get()}/{@link __set()}).
 	 *
-	 * @return void
+	 * @return Dwoo_Adapters_ZendFramework_View
 	 * @return Dwoo_Adapters_ZendFramework_View
 	 */
 	public function clearVars()
@@ -431,7 +431,6 @@ 
 	 * Processes a view script and outputs it. Output is then
 	 * passed through filters.
 	 *
-	 * @param string $name The script script name to process.
 	 * @return string The script output.
 	 */
 	public function _run()

lib/Dwoo/Compiler.php

Doc Comments +3 added lines, -4 removed lines

@@ -270,7 +270,7 @@ 
 	/**
 	 * returns the left and right template delimiters
 	 *
-	 * @return array containing the left and the right delimiters
+	 * @return string[] containing the left and the right delimiters
 	 */
 	public function getDelimiters()
 	{
@@ -358,7 +358,7 @@ 
 	 * adds a preprocessor to the compiler, it will be called
 	 * before the template is compiled
 	 *
-	 * @param mixed $callback either a valid callback to the preprocessor or a simple name if the autoload is set to true
+	 * @param string $callback either a valid callback to the preprocessor or a simple name if the autoload is set to true
 	 * @param bool $autoload if set to true, the preprocessor is auto-loaded from one of the plugin directories, else you must provide a valid callback
 	 */
 	public function addPreProcessor($callback, $autoload = false)
@@ -685,7 +685,6 @@ 
 	/**
 	 * compiles the provided string down to php code
 	 *
-	 * @param string $tpl the template to compile
 	 * @return string a compiled php string
 	 */
 	public function compile(Dwoo_Core $dwoo, Dwoo_ITemplate $template)
@@ -1215,7 +1214,7 @@ 
 	 * returns the token of each parameter out of the given parameter array
 	 *
 	 * @param array $params parameter array
-	 * @return array tokens
+	 * @return Dwoo_Compiler tokens
 	 */
 	public function getParamTokens(array $params)
 	{

lib/Dwoo/Core.php

Doc Comments +4 added lines, -4 removed lines

@@ -303,14 +303,14 @@ 
     /**
      * returns the given template rendered using the provided data and optional compiler
      *
-     * @param mixed $tpl template, can either be a Dwoo_ITemplate object (i.e. Dwoo_Template_File), a valid path to a template, or
+     * @param mixed $_tpl template, can either be a Dwoo_ITemplate object (i.e. Dwoo_Template_File), a valid path to a template, or
      *                   a template as a string it is recommended to provide a Dwoo_ITemplate as it will probably make things faster,
      *                   especially if you render a template multiple times
      * @param mixed $data the data to use, can either be a Dwoo_IDataProvider object (i.e. Dwoo_Data) or an associative array. if you're
      *                    rendering the template from cache, it can be left null
-     * @param Dwoo_ICompiler $compiler the compiler that must be used to compile the template, if left empty a default
+     * @param Dwoo_ICompiler $_compiler the compiler that must be used to compile the template, if left empty a default
      *                                Dwoo_Compiler will be used.
-     * @param bool $output flag that defines whether the function returns the output of the template (false, default) or echoes it directly (true)
+     * @param bool $_output flag that defines whether the function returns the output of the template (false, default) or echoes it directly (true)
      * @return string nothing or the template output if $output is false
      */
     public function get($_tpl, $data = array(), $_compiler = null, $_output = false)
@@ -1462,7 +1462,7 @@ 
      *
      * @param mixed $value the value to assign
      * @param string $scope the variable string, using dwoo variable syntax (i.e. "var.subvar[subsubvar]->property")
-     * @return bool true if assigned correctly or false if a problem occured while parsing the var string
+     * @return null|false true if assigned correctly or false if a problem occured while parsing the var string
      */
     public function assignInScope($value, $scope)
     {

lib/Dwoo/Data.php

Doc Comments -1 removed lines

@@ -66,7 +66,6 @@
 	 * merges the given array(s) with the current data with array_merge
 	 *
 	 * @param array $data the array to merge
-	 * @param array $data2 $data3 ... other arrays to merge, optional, etc.
 	 */
 	public function mergeData(array $data)
 	{

lib/Dwoo/ICompiler.php

Doc Comments +3 added lines, -1 removed lines

@@ -24,7 +24,7 @@ 
 	/**
 	 * compiles the provided string down to php code
 	 *
-	 * @param string $templateStr the template to compile
+	 * @param string $template the template to compile
 	 * @return string a compiled php code string
 	 */
 	public function compile(Dwoo_Core $dwoo, Dwoo_ITemplate $template);
@@ -34,6 +34,7 @@ 
 	 *
 	 * @see Dwoo_Core::addPlugin
 	 * @param array $customPlugins an array of custom plugins
+	 * @return void
 	 */
 	public function setCustomPlugins(array $customPlugins);
 
@@ -44,6 +45,7 @@ 
 	 * set it on the Dwoo object as it will be passed onto the compiler automatically
 	 *
 	 * @param Dwoo_Security_Policy $policy the security policy object
+	 * @return void
 	 */
 	public function setSecurityPolicy(Dwoo_Security_Policy $policy = null);
 }

lib/Dwoo/Loader.php

Doc Comments +3 added lines

@@ -42,6 +42,9 @@
 
 	protected $corePluginDir;
 
+	/**
+	 * @param string $cacheDir
+	 */
 	public function __construct($cacheDir)
 	{
 		$this->corePluginDir = DWOO_DIRECTORY . 'plugins';

lib/Dwoo/Processor.php

Doc Comments -1 removed lines

@@ -27,7 +27,6 @@
 	 * constructor, if you override it, call parent::__construct($dwoo); or assign
 	 * the dwoo instance yourself if you need it
 	 *
-	 * @param Dwoo_Core $dwoo the dwoo instance that runs this plugin
 	 */
 	public function __construct(Dwoo_Compiler $compiler)
 	{