Fixing PhpDoc errors.

src/Munee/Asset/Filter.php

@@ -16,11 +16,15 @@
 abstract class Filter
 {
     /**
+     * List of allowed params for a particular filter
+     *
      * @var array
      */
     protected $allowedParams = array();
 
     /**
+     * Getter for $allowedParams
+     *
      * @return array
      */
     public function getAllowedParams()

src/Munee/Asset/Filter/Css/Minify.php

@@ -19,6 +19,8 @@
 class Minify extends Filter
 {
     /**
+     * List of allowed params for this particular filter
+     *
      * @var array
      */
     protected $allowedParams = array(

src/Munee/Asset/Filter/Image/Colorize.php

@@ -20,6 +20,8 @@
 class Colorize extends Filter
 {
     /**
+     * List of allowed params for this particular filter
+     *
      * @var array
      */
     protected $allowedParams = array(

src/Munee/Asset/Filter/Image/Grayscale.php

@@ -19,6 +19,8 @@
 class Grayscale extends Filter
 {
     /**
+     * List of allowed params for this particular filter
+     *
      * @var array
      */
     protected $allowedParams = array(

src/Munee/Asset/Filter/Image/Negative.php

@@ -19,6 +19,8 @@
 class Negative extends Filter
 {
     /**
+     * List of allowed params for this particular filter
+     *
      * @var array
      */
     protected $allowedParams = array(

src/Munee/Asset/Filter/Image/Resize.php

@@ -23,6 +23,8 @@
 class Resize extends Filter
 {
     /**
+     * List of allowed params for this particular filter
+     *
      * @var array
      */
     protected $allowedParams = array(

src/Munee/Asset/Filter/JavaScript/Minify.php

@@ -19,6 +19,8 @@
 class Minify extends Filter
 {
     /**
+     * List of allowed params for this particular filter
+     *
      * @var array
      */
     protected $allowedParams = array(

src/Munee/Asset/Filter/JavaScript/Packer.php

@@ -19,6 +19,8 @@
 class Packer extends Filter
 {
     /**
+     * List of allowed params for this particular filter
+     *
      * @var array
      */
     protected $allowedParams = array(
@@ -30,9 +32,11 @@ class Packer extends Filter
     );
 
     /**
+     * Default options for the Packer library
+     *
      * @var array
      */
-    protected $_defaultOptions = array(
+    protected $_defaultPackerOptions = array(
         'encoding' => 62,
         'fastDecode' => true,
         'specialChars' => false
@@ -50,7 +54,7 @@ class Packer extends Filter
     public function doFilter($file, $arguments, $javaScriptOptions)
     {
         $userOptions = isset($javaScriptOptions['packer']) ? $javaScriptOptions['packer'] : array();
-        $options = array_merge($this->_defaultOptions, $userOptions);
+        $options = array_merge($this->_defaultPackerOptions, $userOptions);
 
         if (! $arguments['packer']) {
             return;

src/Munee/Asset/NotFoundException.php

@@ -10,4 +10,9 @@
 
 use Munee\ErrorException;
 
+/**
+ * Class NotFoundException
+ *
+ * @author Cody Lundquist
+ */
 class NotFoundException extends ErrorException {}

src/Munee/Asset/Type.php

@@ -23,41 +23,50 @@
 abstract class Type
 {
     /**
+     * Stores the Request Options for the Asset Type
+     *
      * @var array
      */
     protected $options = array();
 
     /**
-     * @var array
-     */
-    protected $params = array();
-
-    /**
+     * Stores the list of filters that will be applied to the requested asset.
+     *
      * @var array
      */
     protected $filters = array();
 
     /**
+     * Stores the path to the cache directory
+     *
      * @var string
      */
     protected $cacheDir;
 
     /**
+     * Stores the last modified date (Epoch) for the requested asset
+     *
      * @var integer
      */
     protected $lastModifiedDate = 0;
 
     /**
+     * Stores the content of the asset
+     *
      * @var string
      */
     protected $content;
 
     /**
+     * Reference to the \Munee\Request class
+     *
      * @var \Munee\Request
      */
     protected $request;
 
     /**
+     * Reference to the \Munee\Response class
+     *
      * @var \Munee\Response
      */
     protected $response;

src/Munee/Asset/Type/Css.php

@@ -22,6 +22,8 @@
 class Css extends Type
 {
     /**
+     * Stores the Request options for this Asset Type
+     *
      * @var array
      */
     protected $options = array(

src/Munee/Asset/Type/Image.php

@@ -20,6 +20,8 @@
 class Image extends Type
 {
     /**
+     * Stores the Request options for this Asset Type
+     *
      * @var array
      */
     protected $options = array(
@@ -42,6 +44,11 @@ class Image extends Type
         'imageProcessor' => 'GD'
     );
 
+    /**
+     * Stores the specific placeholder that will be used for this requested asset, if any.
+     *
+     * @var bool
+     */
     protected $placeholder = false;
 
     /**
@@ -165,6 +172,9 @@ protected function checkNumberOfAllowedFilters($checkImage)
     }
 
     /**
+     * Checks the 'placeholders' Request Option to see if placeholders should be used for missing images
+     * It uses a wildcard syntax (*) to see which placeholder should be used for a particular set of images.
+     *
      * @param string $file
      *
      * @return boolean|string

src/Munee/ErrorException.php

@@ -8,4 +8,9 @@
 
 namespace Munee;
 
+/**
+ * Class ErrorException
+ *
+ * @author Cody Lundquist
+ */
 class ErrorException extends \Exception {}

src/Munee/Request.php

@@ -19,41 +19,57 @@
 class Request
 {
     /**
+     * Stores the path to Webroot
+     *
      * @var string
      */
     public $webroot = WEBROOT;
 
     /**
+     * Stores the file extension of the current request
+     *
      * @var string
      */
     public $ext;
 
     /**
+     * Stores the array of passed in parameters
+     *
      * @var array
      */
     public $params = array();
 
     /**
+     * Stores the array of files passed in
+     *
      * @var array
      */
     public $files = array();
 
     /**
+     * Stores the array of Request Options
+     *
      * @var array
      */
     public $options = array();
 
     /**
+     * Stores the array of Raw $_GET parameters
+     *
      * @var array
      */
     protected $rawParams = array();
 
     /**
+     * Stores the array of allowed parameters for the particular asset being processed
+     *
      * @var array
      */
     protected $allowedParams = array();
 
     /**
+     * Stores the string of raw files passed in from $_GET
+     *
      * @var string
      */
     protected $rawFiles;

src/Munee/Response.php

@@ -16,17 +16,23 @@
 class Response
 {
     /**
+     * Used to check if the request is Not Modified so Munee can return 304 if that is the case
+     *
      * @var boolean
      */
     public $notModified = false;
 
     /**
-     * @var object
+     * Instance of a Asset\HeaderSetter class
+     *
+     * @var Asset\HeaderSetter
      */
     public $headerController;
 
     /**
-     * @var Object
+     * Instance of a Asset\Type dynamically instantiated in the Constructor
+     *
+     * @var Asset\Type
      */
     protected $assetType;