updated PHPDoc comments

Signed-off-by: Jan Pecha <[email protected]>

Git.php

@@ -11,8 +11,10 @@
 	class Git implements IGit
 	{
 		/**
+		 * Creates a tag.
 		 * @param	string
-		 * @return	$this
+		 * @throws	Cz\Git\GitException
+		 * @return	Cz\Git\Git
 		 */
 		public function tag($name)
 		{
@@ -23,9 +25,11 @@ public function tag($name)
 
 
 		/**
+		 * Merges branches.
 		 * @param	string
-		 * @param	string[]|string
-		 * @return	$this
+		 * @param	array|NULL
+		 * @throws	Cz\Git\GitException
+		 * @return	Cz\Git\Git
 		 */
 		public function merge($branch, $options = NULL)
 		{
@@ -36,9 +40,11 @@ public function merge($branch, $options = NULL)
 
 
 		/**
+		 * Creates new branch.
 		 * @param	string
 		 * @param	bool
-		 * @return	$this
+		 * @throws	Cz\Git\GitException
+		 * @return	Cz\Git\Git
 		 */
 		public function branchCreate($name, $checkout = FALSE)
 		{
@@ -56,8 +62,10 @@ public function branchCreate($name, $checkout = FALSE)
 
 
 		/**
+		 * Removes branch.
 		 * @param	string
-		 * @return	$this
+		 * @throws	Cz\Git\GitException
+		 * @return	Cz\Git\Git
 		 */
 		public function branchRemove($name)
 		{
@@ -70,9 +78,9 @@ public function branchRemove($name)
 
 
 		/**
-		 * Gets current branch name
+		 * Gets name of current branch
 		 * @return	string
-		 * @throws	GitException
+		 * @throws	Cz\Git\GitException
 		 */
 		public function branchName()
 		{
@@ -98,8 +106,10 @@ public function branchName()
 
 
 		/**
+		 * Checkout branch.
 		 * @param	string
-		 * @return	$this
+		 * @throws	Cz\Git\GitException
+		 * @return	Cz\Git\Git
 		 */
 		public function checkout($name)
 		{
@@ -110,8 +120,10 @@ public function checkout($name)
 
 
 		/**
+		 * Removes file(s).
 		 * @param	string|string[]
-		 * @return	$this
+		 * @throws	Cz\Git\GitException
+		 * @return	Cz\Git\Git
 		 */
 		public function remove($file)
 		{
@@ -131,8 +143,10 @@ public function remove($file)
 
 
 		/**
+		 * Adds file(s).
 		 * @param	string|string[]
-		 * @return	$this
+		 * @throws	Cz\Git\GitException
+		 * @return	Cz\Git\Git
 		 */
 		public function add($file)
 		{
@@ -152,9 +166,11 @@ public function add($file)
 
 
 		/**
+		 * Commits changes
 		 * @param	string
-		 * @param	string|string[]|NULL
-		 * @return	$this
+		 * @param	string[]  param => value
+		 * @throws	Cz\Git\GitException
+		 * @return	Cz\Git\Git
 		 */
 		public function commit($message, $params = NULL)
 		{
@@ -172,6 +188,7 @@ public function commit($message, $params = NULL)
 
 
 		/**
+		 * Exists changes?
 		 * @return	bool
 		 */
 		public function isChanges()
@@ -183,7 +200,7 @@ public function isChanges()
 
 
 
-		/**
+		/** Runs command.
 		 * @param	string|array
 		 * @return	void
 		 * @throws	Cz\Git\GitException

IGit.php

@@ -8,7 +8,8 @@
 
 	interface IGit
 	{
-		/** Create a tag.
+		/**
+		 * Creates a tag.
 		 * @param	string
 		 * @throws	Cz\Git\GitException
 		 */
@@ -17,6 +18,7 @@ public function tag($name);
 
 
 		/**
+		 * Merges branches.
 		 * @param	string
 		 * @param	array|NULL
 		 * @throws	Cz\Git\GitException
@@ -26,23 +28,26 @@ public function merge($branch, $options = NULL);
 
 
 		/**
+		 * Creates new branch.
 		 * @param	string
 		 * @param	bool
-		 * @throws	Cz\Git\GitException	
+		 * @throws	Cz\Git\GitException
 		 */
 		public function branchCreate($name, $checkout = FALSE);
 
 
 
 		/**
+		 * Removes branch.
 		 * @param	string
 		 * @throws	Cz\Git\GitException
 		 */
 		public function branchRemove($name);
 
 
 
-		/** Returns name of current branch
+		/**
+		 * Gets name of current branch
 		 * @return	string
 		 * @throws	Cz\Git\GitException
 		 */
@@ -51,22 +56,25 @@ public function branchName();
 
 
 		/**
+		 * Checkout of branch.
 		 * @param	string
 		 * @throws	Cz\Git\GitException
 		 */
 		public function checkout($name);
 
 
 
-		/** Removes file.
+		/**
+		 * Removes file(s).
 		 * @param	string|string[]
 		 * @throws	Cz\Git\GitException
 		 */
 		public function remove($file);
 
 
 
-		/** Add file.
+		/**
+		 * Adds file(s).
 		 * @param	string|string[]
 		 * @throws	Cz\Git\GitException
 		 */
@@ -75,6 +83,7 @@ public function add($file);
 
 
 		/**
+		 * Commits changes
 		 * @param	string
 		 * @param	string[]  param => value
 		 * @throws	Cz\Git\GitException
@@ -84,6 +93,7 @@ public function commit($message, $params = NULL);
 
 
 		/**
+		 * Exists changes?
 		 * @return	bool
 		 */
 		public function isChanges();