Browse files

improvements to doc file

  • Loading branch information...
1 parent d6c5593 commit 8639860b24b70cac2bcacdecf8213837b800df8c @kaviththiranga committed Dec 15, 2012
Showing with 6 additions and 3 deletions.
  1. +6 −3 docs/manual/en-US/chapters/packages/media.md
View
9 docs/manual/en-US/chapters/packages/media.md
@@ -32,11 +32,11 @@ Abstract class `JMediaCompressor` defines functions to compress contents of a fi
```
##### Available static functions in JMediaCompressor
-1. static function getInstance() can be used to obtain a compressor object. This function takes an array of options as the
+(1) static function getInstance() can be used to obtain a compressor object. This function takes an array of options as the
argument.
-2. static function compressString() can be used to compress a string without creating and getting a compressor object.
+(2) static function compressString() can be used to compress a string without creating and getting a compressor object.
It needs two arguments, source string and options.
*Example* : How to use JMediaCompressor::compressString()
@@ -51,8 +51,9 @@ It needs two arguments, source string and options.
```
-3. static function compressFiles() takes three arguments, source file, options and destination file. It will compress the contents of source
+(3) static function compressFiles() takes three arguments, source file, options and destination file. It will compress the contents of source
file using the given options and write the compressed contents into destination file.
+
static function isSupported() can be used to check whether there is a compressor supported for a particular file type.
*Example* : How to use JMediaCompressor::compressFile()
@@ -115,6 +116,8 @@ Abstract class `JMediaCollection` defines functions to combine several files int
*Example* : How to obtain a `JMediaCollectionCss` object for css files with a custom compressor and compress and combine a set of files.
+If no compressor object is passed via options and `COMPRESS` is set to `true` in options, a compressor with default options will be used.
+
```php
// Options for compressor

0 comments on commit 8639860

Please sign in to comment.