mirror_php/Cachet
1
0
Fork 0
mirror of https://github.com/CachetHQ/Cachet.git synced 2025-01-18 22:08:11 +01:00
Code Issues Projects Releases Wiki Activity

Fix docblocks

Browse Source
This commit is contained in:
James Brooks 2015-08-06 11:44:01 +01:00
parent e76ecd493e
commit 3f7f4e7624
6 changed files with 22 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
app/Http/Controllers/Api/ComponentController.php
View File

@ -26,7 +26,7 @@ class ComponentController extends AbstractApiController
* *
* @param \Symfony\Component\HttpFoundation\Request $request * @param \Symfony\Component\HttpFoundation\Request $request
* *
* @return \Illuminate\Database\Eloquent\Collection * @return \Illuminate\Http\JsonResponse
*/ */
public function getComponents(Request $request) public function getComponents(Request $request)
{ {
@ -40,7 +40,7 @@ class ComponentController extends AbstractApiController
* *
* @param \CachetHQ\Cachet\Models\Component $component * @param \CachetHQ\Cachet\Models\Component $component
* *
* @return \CachetHQ\Cachet\Models\Component * @return \Illuminate\Http\JsonResponse
*/ */
public function getComponent(Component $component) public function getComponent(Component $component)
{ {
@ -52,7 +52,7 @@ class ComponentController extends AbstractApiController
* *
* @param \Illuminate\Contracts\Auth\Guard $auth * @param \Illuminate\Contracts\Auth\Guard $auth
* *
* @return \CachetHQ\Cachet\Models\Component * @return \Illuminate\Http\JsonResponse
*/ */
public function postComponents(Guard $auth) public function postComponents(Guard $auth)
{ {
@ -86,7 +86,7 @@ class ComponentController extends AbstractApiController
* *
* @param \CachetHQ\Cachet\Models\Componet $component * @param \CachetHQ\Cachet\Models\Componet $component
* *
* @return \CachetHQ\Cachet\Models\Component * @return \Illuminate\Http\JsonResponse
*/ */
public function putComponent(Component $component) public function putComponent(Component $component)
{ {

5
app/Http/Controllers/Api/GeneralController.php
View File

@ -13,6 +13,11 @@ namespace CachetHQ\Cachet\Http\Controllers\Api;
class GeneralController extends AbstractApiController class GeneralController extends AbstractApiController
{ {
/**
* Ping endpoint allows API consumers to check the version.
*
* @return \Illuminate\Http\JsonResponse
*/
public function ping() public function ping()
{ {
return $this->item('Pong!'); return $this->item('Pong!');

8
app/Http/Controllers/Api/IncidentController.php
View File

@ -27,7 +27,7 @@ class IncidentController extends AbstractApiController
* @param \Symfony\Component\HttpFoundation\Request $request * @param \Symfony\Component\HttpFoundation\Request $request
* @param \Illuminate\Contracts\Auth\Guard $auth * @param \Illuminate\Contracts\Auth\Guard $auth
* *
* @return \Illuminate\Database\Eloquent\Collection * @return \Illuminate\Http\JsonResponse
*/ */
public function getIncidents(Request $request, Guard $auth) public function getIncidents(Request $request, Guard $auth)
{ {
@ -43,7 +43,7 @@ class IncidentController extends AbstractApiController
* *
* @param \CachetHQ\Cachet\Models\Incident $incident * @param \CachetHQ\Cachet\Models\Incident $incident
* *
* @return \CachetHQ\Cachet\Models\Incident * @return \Illuminate\Http\JsonResponse
*/ */
public function getIncident(Incident $incident) public function getIncident(Incident $incident)
{ {
@ -55,7 +55,7 @@ class IncidentController extends AbstractApiController
* *
* @param \Illuminate\Contracts\Auth\Guard $auth * @param \Illuminate\Contracts\Auth\Guard $auth
* *
* @return \CachetHQ\Cachet\Models\Incident * @return \Illuminate\Http\JsonResponse
*/ */
public function postIncidents(Guard $auth) public function postIncidents(Guard $auth)
{ {
@ -83,7 +83,7 @@ class IncidentController extends AbstractApiController
* *
* @param \CachetHQ\Cachet\Models\Inicdent $incident * @param \CachetHQ\Cachet\Models\Inicdent $incident
* *
* @return \CachetHQ\Cachet\Models\Incident * @return \Illuminate\Http\JsonResponse
*/ */
public function putIncident(Incident $incident) public function putIncident(Incident $incident)
{ {

6
app/Http/Controllers/Api/MetricController.php
View File

@ -38,7 +38,7 @@ class MetricController extends AbstractApiController
* *
* @param \CachetHQ\Cachet\Models\Metric $metric * @param \CachetHQ\Cachet\Models\Metric $metric
* *
* @return \CachetHQ\Cachet\Models\Metric * @return \Illuminate\Http\JsonResponse
*/ */
public function getMetric(Metric $metric) public function getMetric(Metric $metric)
{ {
@ -60,7 +60,7 @@ class MetricController extends AbstractApiController
/** /**
* Create a new metric. * Create a new metric.
* *
* @return \CachetHQ\Cachet\Models\Metric * @return \Illuminate\Http\JsonResponse
*/ */
public function postMetrics() public function postMetrics()
{ {
@ -78,7 +78,7 @@ class MetricController extends AbstractApiController
* *
* @param \CachetHQ\Cachet\Models\Metric $metric * @param \CachetHQ\Cachet\Models\Metric $metric
* *
* @return \CachetHQ\Cachet\Models\Metric * @return \Illuminate\Http\JsonResponse
*/ */
public function putMetric(Metric $metric) public function putMetric(Metric $metric)
{ {

8
app/Http/Controllers/Api/MetricPointController.php
View File

@ -25,7 +25,7 @@ class MetricPointController extends AbstractApiController
* @param \CachetHQ\Cachet\Models\Metric $metric * @param \CachetHQ\Cachet\Models\Metric $metric
* @param \CachetHQ\Cachet\Models\MetricPoint $metricPoint * @param \CachetHQ\Cachet\Models\MetricPoint $metricPoint
* *
* @return \CachetHQ\Cachet\Models\MetricPoint * @return \Illuminate\Http\JsonResponse
*/ */
public function getMetricPoints(Metric $metric, MetricPoint $metricPoint) public function getMetricPoints(Metric $metric, MetricPoint $metricPoint)
{ {
@ -37,7 +37,7 @@ class MetricPointController extends AbstractApiController
* *
* @param \CachetHQ\Cachet\Models\Metric $metric * @param \CachetHQ\Cachet\Models\Metric $metric
* *
* @return \CachetHQ\Cachet\Models\MetricPoint * @return \Illuminate\Http\JsonResponse
*/ */
public function postMetricPoints(Metric $metric) public function postMetricPoints(Metric $metric)
{ {
@ -64,7 +64,7 @@ class MetricPointController extends AbstractApiController
* @param \CachetHQ\Cachet\Models\Metric $metric * @param \CachetHQ\Cachet\Models\Metric $metric
* @param \CachetHQ\Cachet\Models\MetircPoint $metricPoint * @param \CachetHQ\Cachet\Models\MetircPoint $metricPoint
* *
* @return \CachetHQ\Cachet\Models\MetricPoint * @return \Illuminate\Http\JsonResponse
*/ */
public function putMetricPoint(Metric $metric, MetricPoint $metricPoint) public function putMetricPoint(Metric $metric, MetricPoint $metricPoint)
{ {
@ -87,7 +87,7 @@ class MetricPointController extends AbstractApiController
* @param \CachetHQ\Cachet\Models\Metric $metric * @param \CachetHQ\Cachet\Models\Metric $metric
* @param \CachetHQ\Cachet\Models\MetricPoint $metricPoint * @param \CachetHQ\Cachet\Models\MetricPoint $metricPoint
* *
* @return \Dingo\Api\Http\Response * @return \Illuminate\Http\JsonResponse
*/ */
public function deleteMetricPoint(Metric $metric, MetricPoint $metricPoint) public function deleteMetricPoint(Metric $metric, MetricPoint $metricPoint)
{ {

4
app/Http/Controllers/Api/SubscriberController.php
View File

@ -25,7 +25,7 @@ class SubscriberController extends AbstractApiController
* *
* @param \Symfony\Component\HttpFoundation\Request $request * @param \Symfony\Component\HttpFoundation\Request $request
* *
* @return \Illuminate\Database\Eloquent\Collection * @return \Illuminate\Http\JsonResponse
*/ */
public function getSubscribers(Request $request) public function getSubscribers(Request $request)
{ {
@ -37,7 +37,7 @@ class SubscriberController extends AbstractApiController
/** /**
* Create a new subscriber. * Create a new subscriber.
* *
* @return \CachetHQ\Cachet\Models\Subscriber * @return \Illuminate\Http\JsonResponse
*/ */
public function postSubscribers() public function postSubscribers()
{ {