Changeset 1023

Timestamp:

12/03/2014 07:29:57 PM (9 years ago)

Author:

coffee2code

Message:

developer.wordpress.org: ensure a parameter is set as optional if it has a default value explicitly defined

Some @param docs don't explicitly indicate when a parameter is optional, so infer it from a default value being defined in the method signature.

File:

• sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php

@@ -607 +607 @@
                     $params[ $arg['name'] ]['default'] = $arg['default'];
 
-                    // If a known default is stated in the parameter's description, try to remove it
-                    // since the actual default value is displayed immediately following description.
+                    // If a default value was supplied
                     if ( ! empty( $arg['default'] ) ) {
+                        // Ensure the parameter was marked as optional (sometimes they aren't
+                        // properly and explicitly documented as such)
+                        $params[ $arg['name'] ]['required'] = 'Optional';
+
+                        // If a known default is stated in the parameter's description, try to remove it
+                        // since the actual default value is displayed immediately following description.
                         $default = htmlentities( $arg['default'] );
                         $params[ $arg['name'] ]['content'] = str_replace( "default is {$default}.", '', $params[ $arg['name'] ]['content'] );