aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--_css/css.php22
-rw-r--r--_css/js.php25
2 files changed, 41 insertions, 6 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;
diff --git a/_css/js.php b/_css/js.php
index 6eb056426..eeef8b28b 100644
--- a/_css/js.php
+++ b/_css/js.php
@@ -1,11 +1,30 @@
<?php
/**
- * Elgg CSS file
+ * Outputs a JS view.
+ *
+ * There are 2 main JS views used in elgg:
+ * js/initialise_elgg
+ * js/friendsPickerv1
+ *
+ * The location of the files used to generate these view can change based upon
+ * current viewtype and plugins enabled. By default the viewtype is
+ * 'default' (HTML) and the view files are in views/default/js/. Plugins can
+ * override or extend these views.
+ *
+ * These 2 main JS views are cached via simplecache.
+ *
+ * @see views/js/initialise_elgg.php
+ * @see views/js/friendsPickerv1.php
+ * @see simplecache/view.php
+ * @see elgg_extend_view()
+ *
+ * @uses $_GET['viewtype'] The current viewtype. Determins where to look for the
+ * JS view files.
+ * @uses $_GET['view'] The view to output, relative to the view js/
+ * @uses $override A global that tells simplecache to ignore caching.
*
* @package Elgg
* @subpackage Core
- * @author Curverider Ltd
- * @link http://elgg.org/
*/
global $viewinput, $override;