Docblock improvement.

Signed-off-by: crynobone <crynobone@gmail.com>
orchestral · Jul 19, 2013 · 87c7855 · 87c7855
1 parent 2f1f7e2
commit 87c7855
Show file tree

Hide file tree

Showing 7 changed files with 3 additions and 31 deletions.
diff --git a/src/Orchestra/Memory/Console/MemoryCommand.php b/src/Orchestra/Memory/Console/MemoryCommand.php
@@ -53,7 +53,6 @@ public function fire()
 	/**
 	 * Fire migration process.
 	 *
-	 * @access protected
 	 * @return void
 	 */
 	protected function fireMigration()

diff --git a/src/Orchestra/Memory/Drivers/Cache.php b/src/Orchestra/Memory/Drivers/Cache.php
@@ -12,7 +12,6 @@ class Cache extends Driver {
 	/**
 	 * Load the data from database using Cache.
 	 *
-	 * @access public
 	 * @return void
 	 */
 	public function initiate() 
@@ -24,7 +23,6 @@ public function initiate()
 	/**
 	 * Add a finish event using Cache.
 	 *
-	 * @access public
 	 * @return void
 	 */
 	public function finish() 

diff --git a/src/Orchestra/Memory/Drivers/Driver.php b/src/Orchestra/Memory/Drivers/Driver.php
@@ -47,7 +47,6 @@ abstract class Driver {
 	/**
 	 * Construct an instance.
 	 *
-	 * @access public	
 	 * @param  \Illuminate\Foundation\Application   $app
 	 * @param  string                               $name
 	 * @return void
@@ -67,7 +66,6 @@ public function __construct($app, $name = 'default')
 	/**
 	 * Get value of a key.
 	 *
-	 * @access public
 	 * @param  string   $key        A string of key to search.
 	 * @param  mixed    $default    Default value if key doesn't exist.
 	 * @return mixed
@@ -84,7 +82,6 @@ public function get($key = null, $default = null)
 	/**
 	 * Set a value from a key.
 	 *
-	 * @access public
 	 * @param  string   $key    A string of key to add the value.
 	 * @param  mixed    $value  The value.
 	 * @return mixed
@@ -100,7 +97,6 @@ public function put($key, $value = '')
 	/**
 	 * Delete value of a key.
 	 *
-	 * @access public	
 	 * @param  string   $key    A string of key to delete.
 	 * @return boolean
 	 */
@@ -112,7 +108,6 @@ public function forget($key = null)
 	/**
 	 * Add key with id and checksum.
 	 *
-	 * @access protected
 	 * @param  string   $name
 	 * @param  array    $option
 	 * @return void
@@ -126,7 +121,6 @@ protected function addKey($name, $option)
 	/**
 	 * Is new key.
 	 *
-	 * @access protected
 	 * @param  string   $name
 	 * @return integer
 	 */
@@ -138,7 +132,6 @@ protected function getKeyId($name)
 	/**
 	 * Get ID from key.
 	 *
-	 * @access protected
 	 * @param  string   $name
 	 * @return boolean
 	 */
@@ -150,7 +143,6 @@ protected function isNewKey($name)
 	/**
 	 * Verify checksum.
 	 * 
-	 * @access protected
 	 * @param  string   $name
 	 * @param  string   $check
 	 * @return boolean
@@ -163,17 +155,13 @@ protected function check($name, $check = '')
 	/**
 	 * Initialize method.
 	 *
-	 * @abstract
-	 * @access public
 	 * @return void
 	 */
 	public abstract function initiate();
 
 	/**
 	 * Shutdown method.
 	 *
-	 * @abstract
-	 * @access public
 	 * @return void
 	 */
 	public abstract function finish();

diff --git a/src/Orchestra/Memory/Drivers/Eloquent.php b/src/Orchestra/Memory/Drivers/Eloquent.php
@@ -14,7 +14,6 @@ class Eloquent extends Driver {
 	/**
 	 * Load the data from database using Eloquent ORM.
 	 *
-	 * @access public
 	 * @return void
 	 */
 	public function initiate() 
@@ -39,7 +38,6 @@ public function initiate()
 	/**
 	 * Add a finish event using Eloquent ORM.
 	 *
-	 * @access public
 	 * @return void
 	 */
 	public function finish() 

diff --git a/src/Orchestra/Memory/Drivers/Fluent.php b/src/Orchestra/Memory/Drivers/Fluent.php
@@ -21,7 +21,6 @@ class Fluent extends Driver {
 	/**
 	 * Load the data from database using Fluent Query Builder.
 	 *
-	 * @access public
 	 * @return void
 	 */
 	public function initiate() 
@@ -46,7 +45,6 @@ public function initiate()
 	/**
 	 * Add a finish event using Fluent Query Builder.
 	 *
-	 * @access public
 	 * @return void
 	 */
 	public function finish() 

diff --git a/src/Orchestra/Memory/Drivers/Runtime.php b/src/Orchestra/Memory/Drivers/Runtime.php
@@ -12,8 +12,7 @@ class Runtime extends Driver {
 	/**
 	 * No initialize method for runtime.
 	 *
-	 * @access public
-	 * @return return
+	 * @return boolean
 	 */
 	public function initiate() 
 	{
@@ -23,8 +22,7 @@ public function initiate()
 	/**
 	 * No finish method for runtime.
 	 *
-	 * @access public
-	 * @return return
+	 * @return boolean
 	 */
 	public function finish() 
 	{

diff --git a/src/Orchestra/Memory/MemoryManager.php b/src/Orchestra/Memory/MemoryManager.php
@@ -11,7 +11,6 @@ class MemoryManager extends Manager {
 	/**
 	 * Create Fluent driver.
 	 *
-	 * @access protected
 	 * @param  string   $name
 	 * @return \Orchestra\Memory\Drivers\Fluent
 	 */
@@ -23,7 +22,6 @@ protected function createFluentDriver($name)
 	/**
 	 * Create Eloquent driver.
 	 *
-	 * @access protected
 	 * @param  string   $name
 	 * @return \Orchestra\Memory\Drivers\Eloquent
 	 */
@@ -35,7 +33,6 @@ protected function createEloquentDriver($name)
 	/**
 	 * Create Cache driver.
 	 *
-	 * @access protected
 	 * @param  string   $name
 	 * @return \Orchestra\Memory\Drivers\Cache
 	 */
@@ -47,7 +44,6 @@ protected function createCacheDriver($name)
 	/**
 	 * Create Runtime driver.
 	 *
-	 * @access protected
 	 * @param  string   $name
 	 * @return \Orchestra\Memory\Drivers\Runtime
 	 */
@@ -59,7 +55,6 @@ protected function createRuntimeDriver($name)
 	/**
 	 * Create Default driver.
 	 * 
-	 * @access protected
 	 * @param  string   $name
 	 * @return string
 	 */
@@ -71,7 +66,6 @@ protected function getDefaultDriver()
 	/**
 	 * Make default driver or fallback to runtime.
 	 *
-	 * @access public
 	 * @param  string   $fallbackName
 	 * @return \Orchestra\Memory\Drivers\Driver
 	 */
@@ -90,8 +84,7 @@ public function makeOrFallback($fallbackName = 'orchestra')
 	/**
 	 * Loop every instance and execute finish method (if available)
 	 *
-	 * @access  public
-	 * @return  void
+	 * @return void
 	 */
 	public function finish()
 	{