Added Job usage Documentation

amercier · Aug 9, 2013 · 8a69be4 · 8a69be4
1 parent b61dd5c
commit 8a69be4
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 0 deletions.
diff --git a/docs/api-job.md b/docs/api-job.md
@@ -0,0 +1,25 @@
+\Cli\Helpers\Job
+================
+
+Usage
+-----
+
+On successful jobs:
+```php
+\Cli\Helpers\Job::run('Doing awesome stuff', function() {
+    ...  // awesome stuff
+});
+```
+```
+Doing awesome stuff... OK
+```
+
+On unsuccessful jobs:
+```php
+\Cli\Helpers\Job::run('Fighting Chuck Norris', function() {
+    ...  // throws a RoundHouseKickException('You've received a round-house kick', 'face')
+});
+```
+```
+Fighting Chuck Norris... NOK - You've received a round-house kick in the face
+```
diff --git a/src/Cli/Helpers/Job.php b/src/Cli/Helpers/Job.php
@@ -2,6 +2,32 @@
 
 namespace Cli\Helpers;
 
+/**
+ * Utility class to run a job and catch exceptions.
+ *
+ * Usage
+ * -----
+ *
+ * On successful jobs:
+ * ```php
+ * \Cli\Helpers\Job::run('Doing awesome stuff', function() {
+ *     ...  // awesome stuff
+ * });
+ * ```
+ * ```
+ * Doing awesome stuff... OK
+ * ```
+ *
+ * On unsuccessful jobs:
+ * ```php
+ * \Cli\Helpers\Job::run('Fighting Chuck Norris', function() {
+ *     ...  // throws a RoundHouseKickException('You've received a round-house kick', 'face')
+ * });
+ * ```
+ * ```
+ * Fighting Chuck Norris... NOK - You've received a round-house kick in the face
+ * ```
+ */
 class Job
 {
     protected $message;