Changeset 48576 for trunk/src/wp-includes/class-wp-text-diff-renderer-table.php

Timestamp:

07/23/2020 07:37:57 AM (5 years ago)

Author:

johnbillion

Message:

Docs: Further corrections and improvements to various inline docblocks.

See #49572

File:

• trunk/src/wp-includes/class-wp-text-diff-renderer-table.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-text-diff-renderer-table.php

@@ -338 +338 @@
      * @param array $final Lines of the final version of the text.
      * @return array {
-     *    Array containing results of comparing the original text to the final text.
-     *
-     *    @type array $orig_matches  Associative array of original matches. Index == row
-     *                               number of `$orig`, value == corresponding row number
-     *                               of that same line in `$final` or 'x' if there is no
-     *                               corresponding row (indicating it is a deleted line).
-     *    @type array $final_matches Associative array of final matches. Index == row
-     *                               number of `$final`, value == corresponding row number
-     *                               of that same line in `$orig` or 'x' if there is no
-     *                               corresponding row (indicating it is a new line).
-     *    @type array $orig_rows     Associative array of interleaved rows of `$orig` with
-     *                               blanks to keep matches aligned with side-by-side diff
-     *                               of `$final`. A value >= 0 corresponds to index of `$orig`.
-     *                               Value < 0 indicates a blank row.
-     *    @type array $final_rows    Associative array of interleaved rows of `$final` with
-     *                               blanks to keep matches aligned with side-by-side diff
-     *                               of `$orig`. A value >= 0 corresponds to index of `$final`.
-     *                               Value < 0 indicates a blank row.
+     *     Array containing results of comparing the original text to the final text.
+     *
+     *     @type array $orig_matches  Associative array of original matches. Index == row
+     *                                number of `$orig`, value == corresponding row number
+     *                                of that same line in `$final` or 'x' if there is no
+     *                                corresponding row (indicating it is a deleted line).
+     *     @type array $final_matches Associative array of final matches. Index == row
+     *                                number of `$final`, value == corresponding row number
+     *                                of that same line in `$orig` or 'x' if there is no
+     *                                corresponding row (indicating it is a new line).
+     *     @type array $orig_rows     Associative array of interleaved rows of `$orig` with
+     *                                blanks to keep matches aligned with side-by-side diff
+     *                                of `$final`. A value >= 0 corresponds to index of `$orig`.
+     *                                Value < 0 indicates a blank row.
+     *     @type array $final_rows    Associative array of interleaved rows of `$final` with
+     *                                blanks to keep matches aligned with side-by-side diff
+     *                                of `$orig`. A value >= 0 corresponds to index of `$final`.
+     *                                Value < 0 indicates a blank row.
      * }
      */