Refs #2450: Added documentation for js and css files.

git-svn-id: http://code.elgg.org/elgg/trunk@6909 36083f99-b078-4883-b0ff-0f9b5a30f544

1 files changed, 19 insertions, 3 deletions

diff --git a/_css/css.php b/_css/css.php
index 6d240351c..7aeb0eaa8 100644
--- a/_css/css.php
+++ b/_css/css.php
@@ -1,11 +1,27 @@
 <?php
 /**
- * Elgg CSS file
+ * Outputs the main CSS view.
+ *
+ * Requests to $url/css.css are rewritten via
+ * mod_rewrite rules in .htaccess (or similar) to this file.
+ *
+ * The main CSS is a view located at 'css'.  The location of the
+ * file used to generate this view changes based upon current viewtype
+ * and plugins enabled.  By default the viewtype is 'default' (HTML) and the
+ * view file is views/default/css.php.  Plugins can override or extend this view.
+ *
+ * This view is cached via simplecache.
+ *
+ * @see views/default/css.php
+ * @see simgplecache/view.php
+ * @see elgg_extend_view()
+ *
+ * @uses $_GET['viewtype'] The current viewtype.  Determins where to look for the
+ * css.php view.
+ * @uses $override A global that tells simplecache to ignore caching.
  *
  * @package Elgg
  * @subpackage Core
- * @author Curverider Ltd
- * @link http://elgg.org/
  */
 
 global $viewinput, $override;