Make WordPress Core

Changeset 40971


Ignore:
Timestamp:
06/30/2017 05:28:20 AM (7 years ago)
Author:
DrewAPicture
Message:

Docs: Add full parameter and return documentation for WP_Text_Diff_Renderer_Table::interleave_changed_lines().

Props coffee2code.
Fixes #38520.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-text-diff-renderer-table.php

    r38352 r40971  
    320320     * Takes changed blocks and matches which rows in orig turned into which rows in final.
    321321     *
    322      * Returns
    323      *  *_matches ( which rows match with which )
    324      *  *_rows ( order of rows in each column interleaved with blank rows as
    325      *      necessary )
    326      *
    327      * @since 2.6.0
    328      *
    329      * @param array $orig
    330      * @param array $final
    331      * @return array
     322     * @since 2.6.0
     323     * @access public
     324     *
     325     * @param array $orig  Lines of the original version of the text.
     326     * @param array $final Lines of the final version of the text.
     327     * @return array {
     328     *    Array containing results of comparing the original text to the final text.
     329     *
     330     *    @type array $orig_matches  Associative array of original matches. Index == row
     331     *                               number of `$orig`, value == corresponding row number
     332     *                               of that same line in `$final` or 'x' if there is no
     333     *                               corresponding row (indicating it is a deleted line).
     334     *    @type array $final_matches Associative array of final matches. Index == row
     335     *                               number of `$final`, value == corresponding row number
     336     *                               of that same line in `$orig` or 'x' if there is no
     337     *                               corresponding row (indicating it is a new line).
     338     *    @type array $orig_rows     Associative array of interleaved rows of `$orig` with
     339     *                               blanks to keep matches aligned with side-by-side diff
     340     *                               of `$final`. A value >= 0 corresponds to index of `$orig`.
     341     *                               Value < 0 indicates a blank row.
     342     *    @type array $final_rows    Associative array of interleaved rows of `$final` with
     343     *                               blanks to keep matches aligned with side-by-side diff
     344     *                               of `$orig`. A value >= 0 corresponds to index of `$final`.
     345     *                               Value < 0 indicates a blank row.
     346     * }
    332347     */
    333348    public function interleave_changed_lines( $orig, $final ) {
Note: See TracChangeset for help on using the changeset viewer.