Skip to content

Commit 0454332

Browse files
Merge pull request #5 from kirtangajjar/add_doc_examples
Add usage examples in doc comments
2 parents c1dbc5c + dc62caa commit 0454332

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

src/Mailhog_Command.php

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ class Mailhog_Command extends EE_Command {
2828
*
2929
* [<site-name>]
3030
* : Name of website to enable mailhog on.
31+
*
32+
* ## EXAMPLES
33+
*
34+
* # Enable mailhog for site
35+
* $ ee mailhog up example.com
36+
*
3137
*/
3238
public function up( $args, $assoc_args ) {
3339

@@ -56,6 +62,12 @@ public function up( $args, $assoc_args ) {
5662
*
5763
* [<site-name>]
5864
* : Name of website to disable mailhog on.
65+
*
66+
* ## EXAMPLES
67+
*
68+
* # Disable mailhog for site
69+
* $ ee mailhog down example.com
70+
*
5971
*/
6072
public function down( $args, $assoc_args ) {
6173

@@ -82,6 +94,12 @@ public function down( $args, $assoc_args ) {
8294
*
8395
* [<site-name>]
8496
* : Name of website to know mailhog status for.
97+
*
98+
* ## EXAMPLES
99+
*
100+
* # Check mailhog status on site
101+
* $ ee mailhog status example.com
102+
*
85103
*/
86104
public function status( $args, $assoc_args ) {
87105

0 commit comments

Comments
 (0)