vanderlee / PHPSwaggerGen

SwaggerGen/Parser/AbstractPreprocessor.php

Doc Comments +15 added lines, -1 removed lines

@@ -50,7 +50,7 @@ 
 	 * Get the first word from a string and remove it from the string.
 	 *
 	 * @param string $data
-	 * @return boolean|string
+	 * @return string|false
 	 */
 	private static function wordShift(&$data)
 	{
@@ -61,6 +61,10 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $command
+	 * @param string $expression
+	 */
 	protected function handle($command, $expression)
 	{
 		switch (strtolower($command)) {
@@ -120,6 +124,11 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $content
+	 *
+	 * @return string
+	 */
 	public function preprocess($content)
 	{
 		$this->stack = array();
@@ -127,6 +136,11 @@ 
 		return $this->parseContent($content);
 	}
 
+	/**
+	 * @param string $filename
+	 *
+	 * @return string
+	 */
 	public function preprocessFile($filename)
 	{
 		return $this->preprocess(file_get_contents($filename));

SwaggerGen/Parser/Php/Parser.php

Doc Comments +3 added lines

@@ -65,6 +65,9 @@
 		}
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public function parse($file, Array $dirs = array(), Array $defines = array())
 	{
 		$this->dirs = $this->common_dirs;

Spacing +2 added lines, -2 removed lines

@@ -153,9 +153,9 @@
 				$commandLineNumber = $lineNumber;
 			} elseif ($command) {
 				if ($lineNumber < count($commentLines) - 1) {
-					$data.= ' ' . $line;
+					$data .= ' ' . $line;
 				} else {
-					$data.= preg_replace('~\s*\**\/\s*$~', '', $line);
+					$data .= preg_replace('~\s*\**\/\s*$~', '', $line);
 				}
 			}
 		}

SwaggerGen/Parser/Text/Parser.php

Doc Comments +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
 	 * Get the first word from a string and remove it from the string.
 	 *
 	 * @param string $data
-	 * @return boolean|string
+	 * @return string|false
 	 */
 	private static function wordShift(&$data)
 	{

SwaggerGen/Swagger/AbstractObject.php

Doc Comments +6 added lines, -3 removed lines

@@ -50,6 +50,9 @@ 
 		return $this->parent;
 	}
 
+	/**
+	 * @param string $classname
+	 */
 	protected function getParentClass($classname)
 	{
 		if (is_a($this, $classname)) {
@@ -82,7 +85,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	public function toArray()
 	{
@@ -143,7 +146,7 @@ 
 	/**
 	 * Shifts the first word off a text line and returns it
 	 * @param string $data
-	 * @return string|bool Either the first word or false if no more words available
+	 * @return string|false Either the first word or false if no more words available
 	 */
 	public static function wordShift(&$data)
 	{
@@ -157,7 +160,7 @@ 
 	/**
 	 * Splits a text line in all it's words
 	 * @param string $data
-	 * @return string
+	 * @return string[]
 	 */
 	public static function wordSplit($data)
 	{

SwaggerGen/Swagger/Error.php

Doc Comments +3 added lines

@@ -14,6 +14,9 @@
 class Error extends Response
 {
 
+	/**
+	 * @param string $description
+	 */
 	public function __construct(AbstractObject $parent = null, $code, $description = null)
 	{
 		parent::__construct($parent, $code, null, $description);

SwaggerGen/Swagger/Parameter.php

Doc Comments +4 added lines, -1 removed lines

@@ -62,13 +62,16 @@
 
 	/**
 	 * Return true if the parameter is of type 'formData'
-	 * @return type
+	 * @return boolean
 	 */
 	public function isForm()
 	{
 		return $this->in === 'form';
 	}
 
+	/**
+	 * @param string $in
+	 */
 	public function __construct(AbstractObject $parent, $in, $data, $required = false)
 	{
 		parent::__construct($parent);

SwaggerGen/Swagger/Swagger.php

Doc Comments +4 added lines

@@ -47,6 +47,10 @@
 
 	//private $security;
 
+	/**
+	 * @param string $host
+	 * @param string $basePath
+	 */
 	public function __construct($host = null, $basePath = null)
 	{
 		parent::__construct(null);

Spacing +1 added lines, -1 removed lines

@@ -184,7 +184,7 @@
 				}
 
 				if (!isset($this->Paths[$path])) {
-					$this->Paths[$path] = new Path($this, $Tag ? : $this->defaultTag);
+					$this->Paths[$path] = new Path($this, $Tag ?: $this->defaultTag);
 				}
 				return $this->Paths[$path];
 

SwaggerGen/Swagger/Type/AbstractType.php

Doc Comments +3 added lines

@@ -37,6 +37,9 @@
 		$this->parseDefinition($definition);
 	}
 
+	/**
+	 * @param string $definition
+	 */
 	abstract protected function parseDefinition($definition);
 
 	/**

SwaggerGen/SwaggerGen.php

Doc Comments +2 added lines, -2 removed lines

@@ -73,7 +73,7 @@ 
 	/**
 	 * @param string $file
 	 * @param string[] $dirs
-	 * @return Php\Entity\Statement[]
+	 * @return Statement[]
 	 */
 	private function parseTextFile($file, $dirs)
 	{
@@ -82,8 +82,8 @@ 
 	}
 
 	/**
-	 * @param string $file
 	 * @param string[] $dirs
+	 * @param string $text
 	 * @return Php\Entity\Statement[]
 	 */
 	private function parseText($text, $dirs)

Spacing +2 added lines, -2 removed lines

@@ -157,7 +157,7 @@ 
 
 				$stacktrace = array();
 				foreach ($stack as $object) {
-					$stacktrace[] = (string)$object;
+					$stacktrace[] = (string) $object;
 				}
 				$messages[] = join(", \n", $stacktrace);
 				
@@ -174,7 +174,7 @@ 
 				break;
 
 			case self::FORMAT_JSON_PRETTY:
-				$flags = (defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 0);	// Since PHP 5.4.0
+				$flags = (defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 0); // Since PHP 5.4.0
 				$output = json_encode($output, $flags);
 				break;