From cdae2c0f1f93f0a742432d3711caada45ce7092b Mon Sep 17 00:00:00 2001
From: Ben Roberts <ben@sihnon.net>
Date: Thu, 16 Sep 2010 23:48:28 +0100
Subject: [PATCH] Adds phpdoc for Bluray plugins

---
 .../Source/Plugin/Bluray.class.php            |  4 +++
 .../Worker/Plugin/Bluray.class.php            | 32 +++++++++++++++++++
 2 files changed, 36 insertions(+)

diff --git a/lib/RippingCluster/Source/Plugin/Bluray.class.php b/lib/RippingCluster/Source/Plugin/Bluray.class.php
index 4ecfc27..b3a8c80 100644
--- a/lib/RippingCluster/Source/Plugin/Bluray.class.php
+++ b/lib/RippingCluster/Source/Plugin/Bluray.class.php
@@ -2,6 +2,10 @@
 
 class RippingCluster_Source_Plugin_Bluray extends RippingCluster_PluginBase implements RippingCluster_Source_IPlugin {
     
+    /**
+     * Name of this plugin
+     * @var string
+     */
     const PLUGIN_NAME = "Bluray";
     
     /**
diff --git a/lib/RippingCluster/Worker/Plugin/Bluray.class.php b/lib/RippingCluster/Worker/Plugin/Bluray.class.php
index 5035b55..a25b40d 100644
--- a/lib/RippingCluster/Worker/Plugin/Bluray.class.php
+++ b/lib/RippingCluster/Worker/Plugin/Bluray.class.php
@@ -2,14 +2,42 @@
 
 class RippingCluster_Worker_Bluray extends RippingCluster_PluginBase implements RippingCluster_Worker_IPlugin {
     
+    /**
+     * Name of this plugin
+     * @var string
+     */
     const PLUGIN_NAME = 'Bluray';
     
+    /**
+     * Output produced by the worker process
+     * @var string
+     */
     private $output;
+
+    /**
+     * Gearman Job object describing the task distributed to this worker
+     * @var GearmanJob
+     */
+    private $gearman_job;
     
+    /**
+     * Ripping Job that is being processed by this Worker
+     * @var RippingCluster_Job
+     */
     private $job;
     
+    /**
+     * Associative array of options describing the rip to be carried out
+     * @var array(string=>string)
+     */
     private $rip_options;
     
+    /**
+     * Constructs a new instance of this Worker class
+     * 
+     * @param GearmanJob $gearman_job GearmanJob object describing the task distributed to this worker
+     * @throws RippingCluster_Exception_LogicException
+     */
     private function __construct(GearmanJob $gearman_job) {
         $this->output = '';
         
@@ -44,6 +72,10 @@ class RippingCluster_Worker_Bluray extends RippingCluster_PluginBase implements
         $rip->execute();
     }
         
+    /**
+     * Executes the process for ripping the source to the final output
+     * 
+     */
     private function execute() {
         // TODO
     }