Skip to content

Commit 50d6389

Browse files
authored
Merge pull request #179 from iamgergo/1.x
[1.x] docs formatting
2 parents 34ff218 + 8b683d4 commit 50d6389

File tree

4 files changed

+57
-4
lines changed

4 files changed

+57
-4
lines changed

src/Console/SshCommand.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@ protected function fire()
4444
* Get the server from the task container.
4545
*
4646
* @param \Laravel\Envoy\TaskContainer $container
47-
* @throws \InvalidArgumentException
4847
* @return string
48+
*
49+
* @throws \InvalidArgumentException
4950
*/
5051
protected function getServer(TaskContainer $container)
5152
{

src/Discord.php

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,32 @@ class Discord
88
{
99
use ConfigurationParser;
1010

11+
/**
12+
* The webhook URL.
13+
*
14+
* @var string
15+
*/
1116
public $hook;
17+
18+
/**
19+
* The message.
20+
*
21+
* @var string
22+
*/
1223
public $message;
24+
25+
/**
26+
* The options.
27+
*
28+
* @var array
29+
*/
1330
public $options;
1431

32+
/**
33+
* The task name.
34+
*
35+
* @var string
36+
*/
1537
protected $task;
1638

1739
/**

src/Slack.php

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,39 @@ class Slack
88
{
99
use ConfigurationParser;
1010

11+
/**
12+
* The webhook URL.
13+
*
14+
* @var string
15+
*/
1116
public $hook;
17+
18+
/**
19+
* The Slack channel.
20+
*
21+
* @var mixed
22+
*/
1223
public $channel;
24+
25+
/**
26+
* The message.
27+
*
28+
* @var string
29+
*/
1330
public $message;
31+
32+
/**
33+
* The options.
34+
*
35+
* @var array
36+
*/
1437
public $options;
1538

39+
/**
40+
* The task name.
41+
*
42+
* @var string
43+
*/
1644
protected $task;
1745

1846
/**
@@ -36,7 +64,7 @@ public function __construct($hook, $channel = '', $message = null, $options = []
3664
* Create a new Slack message instance.
3765
*
3866
* @param string $hook
39-
* @param mixed $channel
67+
* @param mixed $channel
4068
* @param string $message
4169
* @param array $options
4270
* @return \Laravel\Envoy\Slack

src/TaskContainer.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,9 @@ public function servers(array $servers)
186186
* Get the IP address for a server.
187187
*
188188
* @param string $server
189-
* @throws \Exception
190189
* @return string|null
190+
*
191+
* @throws \Exception
191192
*/
192193
public function getServer($server)
193194
{
@@ -319,8 +320,9 @@ public function getTasks()
319320
*
320321
* @param string $task
321322
* @param array $macroOptions
322-
* @throws \Exception
323323
* @return \Laravel\Envoy\Task
324+
*
325+
* @throws \Exception
324326
*/
325327
public function getTask($task, array $macroOptions = [])
326328
{

0 commit comments

Comments
 (0)