Permalink
Browse files

Updated docs

Added version tag
Fixed some typos in doc blocks
  • Loading branch information...
1 parent 66e2a2b commit 07fabeccdbbe46b470adeced1a97cc3a02ec34e8 @peteboere committed Sep 20, 2011
Showing with 17 additions and 17 deletions.
  1. +7 −6 CssCrush/CssCrush.php
  2. +10 −11 CssCrush/lib/Core.php
View
@@ -2,14 +2,15 @@
/**
*
* CSS Crush
- *
- * MIT License (http://www.opensource.org/licenses/mit-license.php)
- * Copyright 2010-2011 Pete Boere
- *
- * Example use:
- *
+ *
+ * @version 1.3
+ * @license http://www.opensource.org/licenses/mit-license.php (MIT)
+ * @copyright Copyright 2010-2011 Pete Boere
+ *
+ * @example
* <?php
*
+ * // Basic usage
* require_once 'CssCrush.php';
* $global_css = CssCrush::file( '/css/global.css' );
*
View
@@ -189,7 +189,7 @@ protected static function setPath ( $new_dir ) {
/**
* Process host CSS file and return a new compiled file
*
- * @param string $file Absolute or relative path to the host CSS file
+ * @param string $file URL or System path to the host CSS file
* @param mixed $options An array of options or null
* @return string The public path to the compiled file or an empty string
*/
@@ -277,6 +277,7 @@ public static function file ( $file, $options = null ) {
*
* @param string $file Absolute or relative path to the host CSS file
* @param mixed $options An array of options or null
+ * @param array $attributes An array of HTML attributes
* @return string HTML link tag or error message inside HTML comment
*/
public static function tag ( $file, $options = null, $attributes = array() ) {
@@ -312,7 +313,7 @@ public static function string ( $string, $options = null ) {
/**
* Add variables globally
*
- * @param mixed Assoc array of variable names and values, a php ini filename or null
+ * @param mixed $var Assoc array of variable names and values, a php ini filename or null
*/
public static function globalVars ( $vars ) {
// Merge into the stack, overrides existing variables of the same name
@@ -334,7 +335,7 @@ public static function globalVars ( $vars ) {
/**
* Clear config file and compiled files for the specified directory
*
- * @param string System path to the directory
+ * @param string $dir System path to the directory
*/
public static function clearCache ( $dir = '' ) {
if ( empty( $dir ) ) {
@@ -359,16 +360,14 @@ public static function clearCache ( $dir = '' ) {
}
}
- /**
- * Flag for enabling logging
- *
- * @var boolean
- */
+
+ #####################
+ # Developer
+
+ // Enable logging
public static $logging = false;
- /**
- * Print the log
- */
+ // Print the log
public static function log () {
if ( !self::$logging ) {
return;

0 comments on commit 07fabec

Please sign in to comment.