Fix some PHP docs.

This commit is contained in:
Hereward Mills
2015-12-22 08:41:03 +00:00
parent 09b4912801
commit a78a5ddb04
30 changed files with 53 additions and 7 deletions

View File

@@ -111,7 +111,7 @@ final class UpdateIncidentCommand
/** /**
* Create a new update incident command instance. * Create a new update incident command instance.
* *
* @param \CachetHQ\Cachet\Models\Incident $name * @param \CachetHQ\Cachet\Models\Incident $incident
* @param string $name * @param string $name
* @param int $status * @param int $status
* @param string $message * @param string $message

View File

@@ -32,7 +32,7 @@ final class InviteTeamMemberCommand
/** /**
* Create a new invite team member command instance. * Create a new invite team member command instance.
* *
* @param string[] $email * @param string[] $emails
* *
* @return void * @return void
*/ */

View File

@@ -25,6 +25,8 @@ class ComponentWasAddedEvent implements ComponentEventInterface
/** /**
* Create a new component was added event instance. * Create a new component was added event instance.
* *
* @param Component $component
*
* @return void * @return void
*/ */
public function __construct(Component $component) public function __construct(Component $component)

View File

@@ -25,6 +25,8 @@ class ComponentWasRemovedEvent implements ComponentEventInterface
/** /**
* Create a new component was removed event instance. * Create a new component was removed event instance.
* *
* @param Component $component
*
* @return void * @return void
*/ */
public function __construct(Component $component) public function __construct(Component $component)

View File

@@ -25,6 +25,8 @@ class ComponentWasUpdatedEvent implements ComponentEventInterface
/** /**
* Create a new component was updated event instance. * Create a new component was updated event instance.
* *
* @param Component $component
*
* @return void * @return void
*/ */
public function __construct(Component $component) public function __construct(Component $component)

View File

@@ -25,6 +25,8 @@ class ComponentGroupWasAddedEvent implements ComponentGroupEventInterface
/** /**
* Create a new component group was added event instance. * Create a new component group was added event instance.
* *
* @param ComponentGroup $group
*
* @return void * @return void
*/ */
public function __construct(ComponentGroup $group) public function __construct(ComponentGroup $group)

View File

@@ -25,6 +25,8 @@ class ComponentGroupWasRemovedEvent implements ComponentGroupEventInterface
/** /**
* Create a new component group was removed event instance. * Create a new component group was removed event instance.
* *
* @param ComponentGroup $group
*
* @return void * @return void
*/ */
public function __construct(ComponentGroup $group) public function __construct(ComponentGroup $group)

View File

@@ -25,6 +25,8 @@ class ComponentGroupWasUpdatedEvent implements ComponentGroupEventInterface
/** /**
* Create a new component group was updated event instance. * Create a new component group was updated event instance.
* *
* @param ComponentGroup $group
*
* @return void * @return void
*/ */
public function __construct(ComponentGroup $group) public function __construct(ComponentGroup $group)

View File

@@ -24,6 +24,8 @@ class IncidentWasRemovedEvent implements IncidentEventInterface
/** /**
* Create a new incident was removed event instance. * Create a new incident was removed event instance.
*
* @param Incident $incident
*/ */
public function __construct(Incident $incident) public function __construct(Incident $incident)
{ {

View File

@@ -25,6 +25,8 @@ class IncidentWasReportedEvent implements IncidentEventInterface
/** /**
* Create a new incident has reported event instance. * Create a new incident has reported event instance.
* *
* @param Incident $incident
*
* @return void * @return void
*/ */
public function __construct(Incident $incident) public function __construct(Incident $incident)

View File

@@ -25,6 +25,8 @@ class IncidentWasUpdatedEvent implements IncidentEventInterface
/** /**
* Create a new incident has updated event instance. * Create a new incident has updated event instance.
* *
* @param Incident $incident
*
* @return void * @return void
*/ */
public function __construct(Incident $incident) public function __construct(Incident $incident)

View File

@@ -25,6 +25,8 @@ class MaintenanceWasScheduledEvent implements IncidentEventInterface
/** /**
* Create a new maintenance has scheduled event instance. * Create a new maintenance has scheduled event instance.
* *
* @param Incident $incident
*
* @return void * @return void
*/ */
public function __construct(Incident $incident) public function __construct(Incident $incident)

View File

@@ -25,6 +25,8 @@ class MetricPointWasAddedEvent implements MetricEventInterface
/** /**
* Create a new metric point was added event instance. * Create a new metric point was added event instance.
* *
* @param MetricPoint $metric
*
* @return void * @return void
*/ */
public function __construct(MetricPoint $metric) public function __construct(MetricPoint $metric)

View File

@@ -25,6 +25,8 @@ class MetricPointWasRemovedEvent implements MetricEventInterface
/** /**
* Create a new metric point was removed event instance. * Create a new metric point was removed event instance.
* *
* @param MetricPoint $memtricPoint
*
* @return void * @return void
*/ */
public function __construct(MetricPoint $metricPoint) public function __construct(MetricPoint $metricPoint)

View File

@@ -25,6 +25,8 @@ class MetricPointWasUpdatedEvent implements MetricEventInterface
/** /**
* Create a new metric point was updated event instance. * Create a new metric point was updated event instance.
* *
* @param MetricPoint $point
*
* @return void * @return void
*/ */
public function __construct(MetricPoint $point) public function __construct(MetricPoint $point)

View File

@@ -25,6 +25,8 @@ class MetricWasAddedEvent implements MetricEventInterface
/** /**
* Create a new metric was added event instance. * Create a new metric was added event instance.
* *
* @param Metric $metric
*
* @return void * @return void
*/ */
public function __construct(Metric $metric) public function __construct(Metric $metric)

View File

@@ -25,6 +25,8 @@ class MetricWasRemovedEvent implements MetricEventInterface
/** /**
* Create a new metric was removed event instance. * Create a new metric was removed event instance.
* *
* @param Metric $metric
*
* @return void * @return void
*/ */
public function __construct(Metric $metric) public function __construct(Metric $metric)

View File

@@ -25,6 +25,8 @@ class MetricWasUpdatedEvent implements MetricEventInterface
/** /**
* Create a new metric was updated event instance. * Create a new metric was updated event instance.
* *
* @param Metric $metric
*
* @return void * @return void
*/ */
public function __construct(Metric $metric) public function __construct(Metric $metric)

View File

@@ -25,6 +25,8 @@ class SubscriberHasSubscribedEvent implements SubscriberEventInterface
/** /**
* Create a new subscriber has subscribed event instance. * Create a new subscriber has subscribed event instance.
* *
* @param Subscriber $subscriber
*
* @return void * @return void
*/ */
public function __construct(Subscriber $subscriber) public function __construct(Subscriber $subscriber)

View File

@@ -25,6 +25,8 @@ class SubscriberHasUnsubscribedEvent implements SubscriberEventInterface
/** /**
* Create a new subscriber has unsubscribed event instance. * Create a new subscriber has unsubscribed event instance.
* *
* @param Subscriber $subscriber
*
* @return void * @return void
*/ */
public function __construct(Subscriber $subscriber) public function __construct(Subscriber $subscriber)

View File

@@ -25,6 +25,8 @@ class SubscriberHasVerifiedEvent implements SubscriberEventInterface
/** /**
* Create a new subscriber has subscribed event instance. * Create a new subscriber has subscribed event instance.
* *
* @param Subscriber $subscriber
*
* @return void * @return void
*/ */
public function __construct(Subscriber $subscriber) public function __construct(Subscriber $subscriber)

View File

@@ -25,6 +25,8 @@ final class UserWasAddedEvent implements UserEventInterface
/** /**
* Create a new user was added event instance. * Create a new user was added event instance.
* *
* @param User $user
*
* @return void * @return void
*/ */
public function __construct(User $user) public function __construct(User $user)

View File

@@ -25,6 +25,8 @@ final class UserWasInvitedEvent
/** /**
* Create a new user was invite event instance. * Create a new user was invite event instance.
* *
* @param Invite $invite
*
* @return void * @return void
*/ */
public function __construct(Invite $invite) public function __construct(Invite $invite)

View File

@@ -25,6 +25,8 @@ final class UserWasRemovedEvent implements UserEventInterface
/** /**
* Create a new user was removed event instance. * Create a new user was removed event instance.
* *
* @param User $user
*
* @return void * @return void
*/ */
public function __construct(User $user) public function __construct(User $user)

View File

@@ -173,8 +173,6 @@ abstract class AbstractApiController extends Controller
/** /**
* Respond with a no content response. * Respond with a no content response.
* *
* @param string $message
*
* @return \Illuminate\Http\JsonResponse * @return \Illuminate\Http\JsonResponse
*/ */
protected function noContent() protected function noContent()

View File

@@ -43,6 +43,8 @@ class TeamController extends Controller
/** /**
* Shows the edit team member view. * Shows the edit team member view.
* *
* @param User $user
*
* @return \Illuminate\View\View * @return \Illuminate\View\View
*/ */
public function showTeamMemberView(User $user) public function showTeamMemberView(User $user)

View File

@@ -66,6 +66,8 @@ class UserController extends Controller
/** /**
* Regenerates the users API key. * Regenerates the users API key.
*
* @param User $user
* *
* @return \Illuminate\View\View * @return \Illuminate\View\View
*/ */

View File

@@ -23,8 +23,8 @@ class AppIsSetup
* We're verifying that Cachet is correctly setup. If it is, then we're * We're verifying that Cachet is correctly setup. If it is, then we're
* redirecting the user to the dashboard so they can use Cachet. * redirecting the user to the dashboard so they can use Cachet.
* *
* @param \Illuminate\Routing\Route $route * @param \Illuminate\Http\Request $request
* @param \Closure $next * @param \Closure $next
* *
* @return mixed * @return mixed
*/ */

View File

@@ -20,7 +20,6 @@ class Timezone
* *
* @param \Illuminate\Http\Request $request * @param \Illuminate\Http\Request $request
* @param \Closure $next * @param \Closure $next
* @param string $type
* *
* @return mixed * @return mixed
*/ */

View File

@@ -29,6 +29,7 @@ interface MetricInterface
* Returns metrics for the week. * Returns metrics for the week.
* *
* @param \CachetHQ\Cachet\Models\Metric $metric * @param \CachetHQ\Cachet\Models\Metric $metric
* @param $day
* *
* @return int * @return int
*/ */