From 8b683d497fae9b2ec6138ddb67035ccfd13dde7a Mon Sep 17 00:00:00 2001 From: Gege Date: Fri, 6 Dec 2019 16:35:28 +0100 Subject: [PATCH] docs formatting --- src/Console/SshCommand.php | 3 ++- src/Discord.php | 22 ++++++++++++++++++++++ src/Slack.php | 30 +++++++++++++++++++++++++++++- src/TaskContainer.php | 6 ++++-- 4 files changed, 57 insertions(+), 4 deletions(-) diff --git a/src/Console/SshCommand.php b/src/Console/SshCommand.php index 5957f40f..043b20c9 100644 --- a/src/Console/SshCommand.php +++ b/src/Console/SshCommand.php @@ -44,8 +44,9 @@ protected function fire() * Get the server from the task container. * * @param \Laravel\Envoy\TaskContainer $container - * @throws \InvalidArgumentException * @return string + * + * @throws \InvalidArgumentException */ protected function getServer(TaskContainer $container) { diff --git a/src/Discord.php b/src/Discord.php index d9951b8d..3f59c566 100644 --- a/src/Discord.php +++ b/src/Discord.php @@ -8,10 +8,32 @@ class Discord { use ConfigurationParser; + /** + * The webhook URL. + * + * @var string + */ public $hook; + + /** + * The message. + * + * @var string + */ public $message; + + /** + * The options. + * + * @var array + */ public $options; + /** + * The task name. + * + * @var string + */ protected $task; /** diff --git a/src/Slack.php b/src/Slack.php index 31584058..9ca31dc5 100644 --- a/src/Slack.php +++ b/src/Slack.php @@ -8,11 +8,39 @@ class Slack { use ConfigurationParser; + /** + * The webhook URL. + * + * @var string + */ public $hook; + + /** + * The Slack channel. + * + * @var mixed + */ public $channel; + + /** + * The message. + * + * @var string + */ public $message; + + /** + * The options. + * + * @var array + */ public $options; + /** + * The task name. + * + * @var string + */ protected $task; /** @@ -36,7 +64,7 @@ public function __construct($hook, $channel = '', $message = null, $options = [] * Create a new Slack message instance. * * @param string $hook - * @param mixed $channel + * @param mixed $channel * @param string $message * @param array $options * @return \Laravel\Envoy\Slack diff --git a/src/TaskContainer.php b/src/TaskContainer.php index d40b0e95..92e263e1 100644 --- a/src/TaskContainer.php +++ b/src/TaskContainer.php @@ -186,8 +186,9 @@ public function servers(array $servers) * Get the IP address for a server. * * @param string $server - * @throws \Exception * @return string|null + * + * @throws \Exception */ public function getServer($server) { @@ -319,8 +320,9 @@ public function getTasks() * * @param string $task * @param array $macroOptions - * @throws \Exception * @return \Laravel\Envoy\Task + * + * @throws \Exception */ public function getTask($task, array $macroOptions = []) {