Changeset 47122 for trunk/tests/phpunit/includes/wp-profiler.php

Timestamp:

01/29/2020 12:43:23 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/tests/phpunit/includes/wp-profiler.php (modified) (3 diffs)

trunk/tests/phpunit/includes/wp-profiler.php

@@ -2 +2 @@
 
 /*
-A simple manually-instrumented profiler for WordPress.
-
-This records basic execution time, and a summary of the actions and SQL queries run within each block.
-
-start() and stop() must be called in pairs, for example:
-
-function something_to_profile() {
-    wppf_start(__FUNCTION__);
-    do_stuff();
-    wppf_stop();
-}
-
-Multiple profile blocks are permitted, and they may be nested.
-
-*/
+ * A simple manually-instrumented profiler for WordPress.
+ *
+ * This records basic execution time, and a summary of the actions and SQL queries run within each block.
+ *
+ * start() and stop() must be called in pairs, for example:
+ *
+ * function something_to_profile() {
+ *  wppf_start(__FUNCTION__);
+ *  do_stuff();
+ *  wppf_stop();
+ * }
+ *
+ * Multiple profile blocks are permitted, and they may be nested.
+ */
 
 class WPProfiler {
@@ -34 +33 @@
 
         if ( ! $this->stack ) {
-            // log all actions and filters
+            // Log all actions and filters.
             add_filter( 'all', array( $this, 'log_filter' ) );
         }
 
-        // reset the wpdb queries log, storing it on the profile stack if necessary
+        // Reset the wpdb queries log, storing it on the profile stack if necessary.
         global $wpdb;
         if ( $this->stack ) {
@@ -152 +151 @@
 
     public function _query_count( $queries ) {
-        // this requires the savequeries patch at https://core.trac.wordpress.org/ticket/5218
+        // This requires the SAVEQUERIES patch at https://core.trac.wordpress.org/ticket/5218
         $out = array();
         foreach ( $queries as $q ) {