Wordpress 2.7.1

[autoinstalls/wordpress.git] / wp-includes / functions.wp-scripts.php

diff --git a/wp-includes/functions.wp-scripts.php b/wp-includes/functions.wp-scripts.php
index 87995a4b9ab2915be961a73453ef15db0cf48a6d..1f7e6aca71224e526e5730a73f671f2263e25457 100644 (file)
--- a/wp-includes/functions.wp-scripts.php
+++ b/wp-includes/functions.wp-scripts.php
@@ -1,13 +1,21 @@
 <?php
+/**
+ * BackPress script procedural API.
+ *
+ * @package BackPress
+ * @since r16
+ */
 
 /**
- * Prints script tags in document head
+ * Prints script tags in document head.
  *
- * Called by admin-header.php and by wp_head hook. Since it is called by wp_head on every page load,
- * the function does not instantiate the WP_Scripts object unless script names are explicitly passed.
- * Does make use of already instantiated $wp_scripts if present.
- * Use provided wp_print_scripts hook to register/enqueue new scripts.
+ * Called by admin-header.php and by wp_head hook. Since it is called by wp_head
+ * on every page load, the function does not instantiate the WP_Scripts object
+ * unless script names are explicitly passed. Does make use of already
+ * instantiated $wp_scripts if present. Use provided wp_print_scripts hook to
+ * register/enqueue new scripts.
  *
+ * @since r16
  * @see WP_Scripts::print_scripts()
  */
 function wp_print_scripts( $handles = false ) {
@@ -26,6 +34,12 @@ function wp_print_scripts( $handles = false ) {
        return $wp_scripts->do_items( $handles );
 }
 
+/**
+ * Register new JavaScript file.
+ *
+ * @since r16
+ * @see WP_Scripts::add() For parameter information.
+ */
 function wp_register_script( $handle, $src, $deps = array(), $ver = false ) {
        global $wp_scripts;
        if ( !is_a($wp_scripts, 'WP_Scripts') )
@@ -35,10 +49,11 @@ function wp_register_script( $handle, $src, $deps = array(), $ver = false ) {
 }
 
 /**
- * Localizes a script
+ * Localizes a script.
  *
- * Localizes only if script has already been added
+ * Localizes only if script has already been added.
  *
+ * @since r16
  * @see WP_Script::localize()
  */
 function wp_localize_script( $handle, $object_name, $l10n ) {
@@ -49,6 +64,12 @@ function wp_localize_script( $handle, $object_name, $l10n ) {
        return $wp_scripts->localize( $handle, $object_name, $l10n );
 }
 
+/**
+ * Remove a registered script.
+ *
+ * @since r16
+ * @see WP_Scripts::remove() For parameter information.
+ */
 function wp_deregister_script( $handle ) {
        global $wp_scripts;
        if ( !is_a($wp_scripts, 'WP_Scripts') )
@@ -58,10 +79,11 @@ function wp_deregister_script( $handle ) {
 }
 
 /**
- * Equeues script
+ * Enqueues script.
  *
  * Registers the script if src provided (does NOT overwrite) and enqueues.
  *
+ * @since r16
  * @see WP_Script::add(), WP_Script::enqueue()
 */
 function wp_enqueue_script( $handle, $src = false, $deps = array(), $ver = false ) {