lucas.mathieu/cachet-docker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #1250 from thehereward/fix-some-php-docs

Browse Source 
Fix some PHP docs
This commit is contained in:
Graham Campbell
2015-12-22 19:45:09 +00:00
parent 09b4912801 d176cb9b8f
commit b1b98f9b55
30 changed files with 53 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
app/Commands/Incident/UpdateIncidentCommand.php
View File

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

2
app/Commands/User/InviteTeamMemberCommand.php
View File

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

2
app/Events/Component/ComponentWasAddedEvent.php
View File

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

2
app/Events/Component/ComponentWasRemovedEvent.php
View File

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

2
app/Events/Component/ComponentWasUpdatedEvent.php
View File

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

2
app/Events/ComponentGroup/ComponentGroupWasAddedEvent.php
View File

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

2
app/Events/ComponentGroup/ComponentGroupWasRemovedEvent.php
View File

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

2
app/Events/ComponentGroup/ComponentGroupWasUpdatedEvent.php
View File

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

2
app/Events/Incident/IncidentWasRemovedEvent.php
View File

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

2
app/Events/Incident/IncidentWasReportedEvent.php
View File

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

2
app/Events/Incident/IncidentWasUpdatedEvent.php
View File

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

2
app/Events/Incident/MaintenanceWasScheduledEvent.php
View File

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

2
app/Events/Metric/MetricPointWasAddedEvent.php
View File

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

2
app/Events/Metric/MetricPointWasRemovedEvent.php
View File

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

2
app/Events/Metric/MetricPointWasUpdatedEvent.php
View File

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

2
app/Events/Metric/MetricWasAddedEvent.php
View File

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

2
app/Events/Metric/MetricWasRemovedEvent.php
View File

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

2
app/Events/Metric/MetricWasUpdatedEvent.php
View File

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

2
app/Events/Subscriber/SubscriberHasSubscribedEvent.php
View File

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

2
app/Events/Subscriber/SubscriberHasUnsubscribedEvent.php
View File

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

2
app/Events/Subscriber/SubscriberHasVerifiedEvent.php
View File

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

2
app/Events/User/UserWasAddedEvent.php
View File

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

2
app/Events/User/UserWasInvitedEvent.php
View File

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

2
app/Events/User/UserWasRemovedEvent.php
View File

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

2
app/Http/Controllers/Api/AbstractApiController.php
View File

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

2
app/Http/Controllers/Dashboard/TeamController.php
View File

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

2
app/Http/Controllers/Dashboard/UserController.php
View File

@@ -67,6 +67,8 @@ class UserController extends Controller
/**
* Regenerates the users API key.
*
* @param \CachetHQ\Cachet\Models\User $user
*
* @return \Illuminate\View\View
*/
public function regenerateApiKey(User $user)

4
app/Http/Middleware/AppIsSetup.php
View File

@@ -23,8 +23,8 @@ class AppIsSetup
* 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.
*
* @param \Illuminate\Routing\Route $route
* @param \Closure $next
* @param \Illuminate\Http\Request $request
* @param \Closure $next
*
* @return mixed
*/

1
app/Http/Middleware/Timezone.php
View File

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

1
app/Repositories/Metric/MetricInterface.php
View File

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