finished up, tests passing, fixed cs

This commit is contained in:
Evan Villemez 2012-08-27 13:25:03 -04:00
parent 2902ac3cbb
commit 504d5125f9
7 changed files with 46 additions and 13 deletions

View File

@ -85,6 +85,22 @@ class MarkdownFormatter extends AbstractFormatter
}
}
if (isset($data['response'])) {
$markdown .= "#### Response ####\n\n";
foreach ($data['response'] as $name => $parameter) {
$markdown .= sprintf("%s:\n\n", $name);
$markdown .= sprintf(" * type: %s\n", $parameter['dataType']);
$markdown .= sprintf(" * required: %s\n", $parameter['required'] ? 'true' : 'false');
if (isset($parameter['description']) && !empty($parameter['description'])) {
$markdown .= sprintf(" * description: %s\n", $parameter['description']);
}
$markdown .= "\n";
}
}
return $markdown;
}

View File

@ -81,7 +81,6 @@ class JmsMetadataParser implements ParserInterface
//TODO: regex comment to get description - or move doc comment parsing functionality from `ApiDocExtractor` to a new location
//in order to reuse it here
return $description;
}

View File

@ -104,7 +104,7 @@ class TestController
/**
* @ApiDoc(
* description="Testing return",
* return="test_type"
* return="dependency_type"
* )
*/
public function jmsReturnTestAction()

View File

@ -186,6 +186,19 @@ arr:
* description: No description.
### `GET` /jms-return-test ###
_Testing return_
#### Response ####
a:
* type: string
* required: true
* description: A nice description
### `ANY` /my-commented/{id}/{page} ###
_This method is useful to test if the getDocComment works._

View File

@ -220,7 +220,12 @@ class SimpleFormatterTest extends WebTestCase
'uri' => '/jms-return-test',
'description' => 'Testing return',
'response' => array(
'a' => array(
'dataType' => 'string',
'required' => true,
'description' => 'A nice description',
'readonly' => false
)
)
),
5 =>