aboutsummaryrefslogtreecommitdiff
path: root/_css/js.php
diff options
context:
space:
mode:
authorbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-09-06 14:29:03 +0000
committerbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-09-06 14:29:03 +0000
commit96cc0076fa36422673f3138ba2c35ff46be2119c (patch)
tree26addf9cb459a94d5e8f6593a31f652a536b2e0e /_css/js.php
parent76dac45ebaf104b312a8527a05424601ca9d520a (diff)
downloadelgg-96cc0076fa36422673f3138ba2c35ff46be2119c.tar.gz
elgg-96cc0076fa36422673f3138ba2c35ff46be2119c.tar.bz2
Refs #2450: Added documentation for js and css files.
git-svn-id: http://code.elgg.org/elgg/trunk@6909 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to '_css/js.php')
-rw-r--r--_css/js.php25
1 files changed, 22 insertions, 3 deletions
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;