Changeset 32566

Timestamp:

05/24/2015 05:04:39 AM (9 years ago)

Author:

wonderboymusic

Message:

Add missing doc blocks to class.wp-(scripts|styles).php.

See #32444.

Location:

trunk/src/wp-includes

Files:

• class.wp-scripts.php (modified) (10 diffs)
• class.wp-styles.php (modified) (1 diff)

trunk/src/wp-includes/class.wp-scripts.php

@@ -62 +62 @@
     }
 
-    // Deprecated since 3.3, see print_extra_script()
+    /**
+     * @deprecated 3.3
+     * @see print_extra_script()
+     *
+     * @param string $handle
+     * @param bool   $echo
+     * @return bool|string|null
+     */
     public function print_scripts_l10n( $handle, $echo = true ) {
         _deprecated_function( __FUNCTION__, '3.3', 'print_extra_script()' );
@@ -68 +75 @@
     }
 
+    /**
+     * @param string $handle
+     * @param bool   $echo
+     * @return bool|string|null
+     */
     public function print_extra_script( $handle, $echo = true ) {
         if ( !$output = $this->get_data( $handle, 'data' ) )
@@ -84 +96 @@
     }
 
+    /**
+     * @param string   $handle Name of the item. Should be unique.
+     * @param int|bool $group
+     * @return bool True on success, false if not set.
+     */
     public function do_item( $handle, $group = false ) {
         if ( !parent::do_item($handle) )
@@ -164 +181 @@
         $tag = "{$cond_before}<script type='text/javascript' src='$src'></script>\n{$cond_after}";
 
-        /** 
+        /**
          * Filter the HTML script tag of an enqueued script.
          *
@@ -185 +202 @@
 
     /**
-     * Localizes a script
+     * Localizes a script, only if the script has already been added
      *
-     * Localizes only if the script has already been added
+     * @param string $handle
+     * @param string $object_name
+     * @param array $l10n
+     * @return bool
      */
     public function localize( $handle, $object_name, $l10n ) {
@@ -218 +238 @@
     }
 
+    /**
+     * @param string $handle    Name of the item. Should be unique.
+     * @param bool   $recursion Internal flag that calling function was called recursively.
+     * @param mixed  $group     Group level.
+     * @return bool Not already in the group or a lower group
+     */
     public function set_group( $handle, $recursion, $group = false ) {
-
         if ( $this->registered[$handle]->args === 1 )
             $grp = 1;
@@ -231 +256 @@
     }
 
+    /**
+     * @param mixed $handles   Item handle and argument (string) or item handles and arguments (array of strings).
+     * @param bool  $recursion Internal flag that function is calling itself.
+     * @param mixed $group     Group level: (int) level, (false) no groups.
+     * @return bool True on success, false on failure.
+     */
     public function all_deps( $handles, $recursion = false, $group = false ) {
         $r = parent::all_deps( $handles, $recursion );
@@ -246 +277 @@
     }
 
+    /**
+     * @return array
+     */
     public function do_head_items() {
         $this->do_items(false, 0);
@@ -251 +285 @@
     }
 
+    /**
+     * @return array
+     */
     public function do_footer_items() {
         $this->do_items(false, 1);
@@ -256 +293 @@
     }
 
+    /**
+     * @param string $src
+     * @return bool
+     */
     public function in_default_dir( $src ) {
         if ( ! $this->default_dirs ) {

trunk/src/wp-includes/class.wp-styles.php

@@ -235 +235 @@
     }
 
+    /**
+     * @return array
+     */
     public function do_footer_items() { // HTML 5 allows styles in the body, grab late enqueued items and output them in the footer.
         $this->do_items(false, 1);