瀏覽代碼

Updated documentation.

Taddeus Kroes 14 年之前
父節點
當前提交
dc95da1c98
共有 7 個文件被更改,包括 26 次插入15 次删除
  1. 3 2
      pquery.array.php
  2. 5 3
      pquery.cache.php
  3. 3 2
      pquery.css.php
  4. 3 2
      pquery.js.php
  5. 2 1
      pquery.sql.php
  6. 2 1
      pquery.template.php
  7. 8 4
      pquery.url.php

+ 3 - 2
pquery.array.php

@@ -1,12 +1,13 @@
 <?php
 /**
- * pQuery plugin for executing common array functions.
+ * pQuery plugin for easily executing practical functions on arrays, in a
+ * more object-oriented manner than natively supported by PHP.
  * 
  * @package pQuery
  */
 
 /**
- * @todo Documentation
+ * pQuery extension class for the 'array' plugin.
  */
 class pQueryArray extends pQuery {
 	static $accepts = array('array');

+ 5 - 3
pquery.cache.php

@@ -1,13 +1,15 @@
 <?php
 /**
- * pQuery plugin for parsing templates.
+ * pQuery plugin for cache-control of a list of files.
  * 
  * @package pQuery
  */
 
 /**
- * @todo Documentation
- * @property string $files 
+ * pQuery extension class for the 'cache' plugin.
+ * 
+ * @property string $files The list of files in the cached object.
+ * @todo Method documentation
  */
 class pQueryCache extends pQuery {
 	const CACHE_FOLDER = 'cache/';

+ 3 - 2
pquery.css.php

@@ -1,6 +1,7 @@
 <?php
 /**
- * pQuery plugin for parsing templates.
+ * pQuery plugin for composing sets of CSS stylesheets.
+ * The plugin has built-in cache control and uses the CssParser class.
  * 
  * @package pQuery
  */
@@ -9,7 +10,7 @@ __p::require_plugins('cache');
 __p::load_utils('CssParser');
 
 /**
- * @todo Documentation
+ * pQuery extension class for the 'css' plugin.
  */
 class pQueryCss extends pQueryCache {
 	static $accepts = array('array' => 'add_extensions', 'string' => 'make_array');

+ 3 - 2
pquery.js.php

@@ -1,6 +1,7 @@
 <?php
 /**
- * pQuery plugin for parsing templates.
+ * pQuery plugin for composing sets of JavaScript files.
+ * The plugin has built-in cache control and supports the JShrink minifier.
  * 
  * @package pQuery
  */
@@ -9,7 +10,7 @@ __p::require_plugins('cache');
 __p::load_utils('jshrink');
 
 /**
- * @todo Documentation
+ * pQuery extension class for the 'js' plugin.
  */
 class pQueryJs extends pQueryCache {
 	static $accepts = array('array' => 'add_extensions', 'string' => 'make_array');

+ 2 - 1
pquery.sql.php

@@ -6,7 +6,8 @@
  */
 
 /**
- * @todo Documentation
+ * pQuery extension class for the 'sql' plugin.
+ * 
  * @property $query The query that is being evaluated.
  */
 class pQuerySql extends pQuery {

+ 2 - 1
pquery.template.php

@@ -8,7 +8,8 @@
 __p::load_utils('block');
 
 /**
- * @todo Documentation
+ * pQuery extension class for the 'tpl' plugin.
+ * 
  * @property string $content The template's content.
  */
 class pQueryTemplate extends pQuery {

+ 8 - 4
pquery.url.php

@@ -1,13 +1,14 @@
 <?php
 /**
- * pQuery plugin for parsing templates.
+ * pQuery plugin for parsing URL's and calling corresponding handlers.
  * 
  * @package pQuery
  */
 
 /**
- * @todo Documentation
- * @property string $content The template's content.
+ * pQuery extension class for the 'url' plugin.
+ * 
+ * @property string $url The current url, with slashes removed at begin and end.
  */
 class pQueryUrl extends pQuery {
 	static $accepts = array('string' => 'parse_url');
@@ -19,9 +20,12 @@ class pQueryUrl extends pQuery {
 	static $variable_alias = 'url';
 	
 	/**
+	 * The current set of handlers, pointed to by regular expression patterns.
 	 * 
+	 * The handler that is called for the current URL is the one corresponding
+	 * to the first pattern in this list that matches the URL.
 	 * 
-	 * @var string
+	 * @var array
 	 */
 	static $handlers = array();