ci-bonfire / Sprint

application/helpers/markdown_helper.php

Doc Comments +18 added lines

@@ -1122,6 +1122,10 @@ 
 
     var $list_level = 0;
 
+    /**
+     * @param string $list_str
+     * @param string $marker_any_re
+     */
     function processListItems($list_str, $marker_any_re)
     {
         #
@@ -1234,6 +1238,9 @@ 
         return "\n\n" . $this->hashBlock($codeblock) . "\n\n";
     }
 
+    /**
+     * @param string $code
+     */
     function makeCodeSpan($code)
     {
         #
@@ -1751,6 +1758,9 @@ 
     # hanlde UTF-8 if the default function does not exist.
     var $utf8_strlen = 'mb_strlen';
 
+    /**
+     * @param string $text
+     */
     function detab($text)
     {
         #
@@ -2340,6 +2350,11 @@ 
         return array($parsed, $text);
     }
 
+    /**
+     * @param string $text
+     * @param string $hash_method
+     * @param boolean $md_attr
+     */
     function _hashHTMLBlocks_inHTML($text, $hash_method, $md_attr)
     {
         #
@@ -3078,6 +3093,9 @@ 
         return $this->hashBlock($result) . "\n\n";
     }
 
+    /**
+     * @return string
+     */
     function processDefListItems($list_str)
     {
         #

application/libraries/Migration.php

Doc Comments +2 added lines, -2 removed lines

@@ -321,7 +321,7 @@ 
      *
      * @param string $type  Any key from _migration_paths, or {module_name}
      *
-     * @return bool|string
+     * @return false|string
      */
     public function get_latest($type='app')
     {
@@ -465,7 +465,7 @@ 
 	/**
 	 * Based on the 'type', determines the correct migration path.
 	 *
-	 * @param $type
+	 * @param string $type
 	 * @param bool $create
 	 *
 	 * @return null|string

application/models/User_model.php

Doc Comments +1 added lines, -1 removed lines

@@ -292,7 +292,7 @@
      * @param $user_id
      * @param $key
      *
-     * @return bool
+     * @return false|null
      */
     public function removeMetaFromUser($user_id, $key)
     {

application/third_party/HMVC/Loader.php

Doc Comments +6 added lines, -6 removed lines

@@ -107,7 +107,7 @@ 
      * @param	string	the name of the class
      * @param	mixed	the optional parameters
      * @param	string	an optional object name
-     * @return	void
+     * @return	null|HMVC_Loader
      */
     public function library($library = '', $params = NULL, $object_name = NULL) {
         if (is_array($library)) {
@@ -147,7 +147,7 @@ 
      * @param	string	the name of the class
      * @param	string	name for the model
      * @param	bool	database connection
-     * @return	void
+     * @return	null|HMVC_Loader
      */
     public function model($model, $name = '', $db_conn = FALSE) {
         if (is_array($model)) {
@@ -232,7 +232,7 @@ 
      * @param	string
      * @param	bool
      * @param 	bool
-     * @return	void
+     * @return	boolean|null
      */
     public function config($file = '', $use_sections = FALSE, $fail_gracefully = FALSE) {
         // Detect module
@@ -263,7 +263,7 @@ 
      * This function loads the specified helper file.
      *
      * @param	mixed
-     * @return	void
+     * @return	null|HMVC_Loader
      */
     public function helper($helper = array()) {
         if (is_array($helper)) {
@@ -300,7 +300,7 @@ 
      *
      * @param	array
      * @param	string
-     * @return	void
+     * @return	null|HMVC_Loader
      */
     public function language($file = array(), $lang = '') {
         if (is_array($file)) {
@@ -517,7 +517,7 @@ 
      * Searches a given module name. Returns the path if found, FALSE otherwise
      *
      * @param string $module
-     * @return string|boolean
+     * @return string|false
      */
     private function find_module($module) {
         $config = & $this->_ci_get_component('config');

build/lib/BaseBuilder.php

Doc Comments +8 added lines, -4 removed lines

@@ -21,8 +21,8 @@ 
 	 * Copies the entire contents of a single folder
 	 * into a source folder, recursively.
 	 *
-	 * @param $source
-	 * @param $destination
+	 * @param string $source
+	 * @param string $destination
 	 */
 	public function copyFolder($source, $destination)
 	{
@@ -71,8 +71,8 @@ 
 	 * Deletes all files and folders, recursively, within $path,
 	 * except for any files listed in the $leave_files array.
 	 *
-	 * @param $path
-	 * @param array $leave_files
+	 * @param string $path
+	 * @param string[] $leave_files
 	 */
 	public function cleanFolder($path, $leave_files=[])
 	{
@@ -97,6 +97,10 @@ 
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * @param string $source
+	 * @param string $destination
+	 */
 	public function compressFolder($source, $destination, $include_dir=false)
 	{
 		if (! extension_loaded('zip') ) {

myth/_generators/Api/ApiGenerator.php

Doc Comments +17 added lines, -10 removed lines

@@ -103,7 +103,7 @@ 
 	 * Quickly creates boilerplate code for a new API resource.
 	 *
 	 * @param $segments
-	 * @param $quiet
+	 * @param boolean $quiet
 	 */
 	private function scaffold( $segments, $quiet )
 	{
@@ -220,6 +220,9 @@ 
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * @param string $name
+	 */
 	private function detectModel($name)
 	{
 		$model_name = ucfirst($name) .'_model.php';
@@ -242,8 +245,8 @@ 
     /**
      * Creates the new APIController - based resource with basic CRUD.
      *
-     * @param $single
-     * @param $plural
+     * @param string $single
+     * @param string $plural
      * @param $version
      *
      * @return $this
@@ -271,8 +274,8 @@ 
     /**
      * Creates the language file to accompany the controller.
      *
-     * @param $single
-     * @param $plural
+     * @param string $single
+     * @param string $plural
      * @param $version
      *
      * @return $this
@@ -297,8 +300,8 @@ 
      * Creates the API Blueprint file for that resource in
      * APPPATH/docs/api
      *
-     * @param $single
-     * @param $plural
+     * @param string $single
+     * @param string $plural
      * @param $version
      * @param $model
      *
@@ -349,7 +352,7 @@ 
      * Modifies the _toc.ini file (or creates) for the specified Blueprint docs.
      *
      * @param $plural
-     * @param $version
+     * @param string $version
      *
      * @return $this|bool
      */
@@ -385,7 +388,7 @@ 
      * Creates a generic representation of the object from the database
      * table.
      *
-     * @param $model
+     * @param string $model
      *
      * @return string
      */
@@ -537,6 +540,10 @@ 
 	//--------------------------------------------------------------------
 
 
+	/**
+	 * @param string $tpl
+	 * @param string $name
+	 */
 	private function makeMigration( $tpl, $name )
 	{
 		// Create the migration
@@ -561,7 +568,7 @@ 
 	/**
 	 * Modifies the config/api.php file and sets the Auth type
 	 *
-	 * @param $type
+	 * @param string $type
 	 */
 	private function setAuthType( $type )
 	{

myth/_generators/Controller/ControllerGenerator.php

Doc Comments +7 added lines

@@ -97,6 +97,9 @@ 
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * @param string $name
+	 */
 	protected function quietSetOptions( $name )
 	{
 		$options = CLI::getOptions();
@@ -120,6 +123,9 @@ 
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * @param string $name
+	 */
 	protected function collectOptions( $name )
 	{
 		$options = CLI::getOptions();
@@ -159,6 +165,7 @@ 
 
 	/**
 	 * Generates the standard views for our CRUD methods.
+	 * @param string $name
 	 */
 	protected function createViews( $name )
 	{

myth/_generators/Migration/MigrationGenerator.php

Doc Comments +5 added lines, -2 removed lines

@@ -159,7 +159,7 @@ 
 	 *  'create_user_table'         action = 'create', table = 'user'
 	 *  'add_name_to_user_table     action = 'add', table = 'user'
 	 *
-	 * @param $name
+	 * @param string $name
 	 */
 	public function detectAction($name)
 	{
@@ -199,6 +199,9 @@ 
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * @param string $name
+	 */
 	public function collectOptions($name, $quiet=false)
 	{
 		$options = CLI::getOptions();
@@ -308,7 +311,7 @@ 
 	 * Reads the fields from an existing table and fills out our
 	 * $fields array and $primary key information.
 	 *
-	 * @param $table
+	 * @param string $table
 	 */
 	protected function readTable($table)
 	{

myth/_generators/Model/ModelGenerator.php

Doc Comments +7 added lines

@@ -107,6 +107,10 @@ 
 	/*
 	 * Customizes our settings
 	 */
+
+	/**
+	 * @param string $model_name
+	 */
 	protected function collectOptions( $model_name, $options=[] )
 	{
 		$this->load->helper( 'inflector' );
@@ -180,6 +184,9 @@ 
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * @param string $model_name
+	 */
 	protected function quietSetOptions( $model_name, $options=[] )
 	{
 		$this->load->helper( 'inflector' );