Changeset 47122 for trunk/src/wp-includes/pomo/mo.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/src/wp-includes/pomo/mo.php (modified) (13 diffs)

trunk/src/wp-includes/pomo/mo.php

@@ -102 +102 @@
             $magic                     = 0x950412de;
             $revision                  = 0;
-            $total                     = count( $entries ) + 1; // all the headers are one entry
+            $total                     = count( $entries ) + 1; // All the headers are one entry.
             $originals_lenghts_addr    = 28;
             $translations_lenghts_addr = $originals_lenghts_addr + 8 * $total;
@@ -123 +123 @@
             fseek( $fh, $originals_lenghts_addr );
 
-            // headers' msgid is an empty string
+            // Headers' msgid is an empty string.
             fwrite( $fh, pack( 'VV', 0, $current_addr ) );
             $current_addr++;
@@ -134 +134 @@
                 $length           = $reader->strlen( $this->export_original( $entry ) );
                 fwrite( $fh, pack( 'VV', $length, $current_addr ) );
-                $current_addr += $length + 1; // account for the NULL byte after
+                $current_addr += $length + 1; // Account for the NULL byte after.
             }
 
@@ -159 +159 @@
          */
         function export_original( $entry ) {
-            //TODO: warnings for control characters
+            // TODO: Warnings for control characters.
             $exported = $entry->singular;
             if ( $entry->is_plural ) {
@@ -175 +175 @@
          */
         function export_translations( $entry ) {
-            //TODO: warnings for control characters
+            // TODO: Warnings for control characters.
             return $entry->is_plural ? implode( "\0", $entry->translations ) : $entry->translations[0];
         }
@@ -195 +195 @@
          */
         function get_byteorder( $magic ) {
-            // The magic is 0x950412de
+            // The magic is 0x950412de.
 
             // bug in PHP 5.0.2, see https://savannah.nongnu.org/bugs/?func=detailitem&item_id=10565
@@ -229 +229 @@
             }
 
-            // parse header
+            // Parse header.
             $header = unpack( "{$endian}revision/{$endian}total/{$endian}originals_lenghts_addr/{$endian}translations_lenghts_addr/{$endian}hash_length/{$endian}hash_addr", $header );
             if ( ! is_array( $header ) ) {
@@ -235 +235 @@
             }
 
-            // support revision 0 of MO format specs, only
+            // Support revision 0 of MO format specs, only.
             if ( $header['revision'] != 0 ) {
                 return false;
             }
 
-            // seek to data blocks
+            // Seek to data blocks.
             $reader->seekto( $header['originals_lenghts_addr'] );
 
-            // read originals' indices
+            // Read originals' indices.
             $originals_lengths_length = $header['translations_lenghts_addr'] - $header['originals_lenghts_addr'];
             if ( $originals_lengths_length != $header['total'] * 8 ) {
@@ -254 +254 @@
             }
 
-            // read translations' indices
+            // Read translations' indices.
             $translations_lenghts_length = $header['hash_addr'] - $header['translations_lenghts_addr'];
             if ( $translations_lenghts_length != $header['total'] * 8 ) {
@@ -265 +265 @@
             }
 
-            // transform raw data into set of indices
+            // Transform raw data into set of indices.
             $originals    = $reader->str_split( $originals, 8 );
             $translations = $reader->str_split( $translations, 8 );
 
-            // skip hash table
+            // Skip hash table.
             $strings_addr = $header['hash_addr'] + $header['hash_length'] * 4;
 
@@ -284 +284 @@
                 }
 
-                // adjust offset due to reading strings to separate space before
+                // Adjust offset due to reading strings to separate space before.
                 $o['pos'] -= $strings_addr;
                 $t['pos'] -= $strings_addr;
@@ -320 +320 @@
                 $entry->context = $parts[0];
             }
-            // look for plural original
+            // Look for plural original.
             $parts           = explode( "\0", $original );
             $entry->singular = $parts[0];
@@ -327 +327 @@
                 $entry->plural    = $parts[1];
             }
-            // plural translations are also separated by \0
+            // Plural translations are also separated by \0.
             $entry->translations = explode( "\0", $translation );
             return $entry;