ryanwelcher
7/10/2015 - 12:06 AM

Docblock for WordPress PHPUnit dataProvider

Docblock for WordPress PHPUnit dataProvider

/**
 *
 * Data provider
 *
 * Description
 *
 * @see {method name receiving data}
 *
 * @since x.x.x
 *
 * @otherPHPUnitSpecificItems
 *
 * @return array {
 *      @type type $param_name_in_receiving_method Desciption.
 *      @type type $param_name_in_receiving_method Very long description that gets
 *                                                 wrapped to the starting point.        
 * }
 *
 */



EXAMPLE::
/**
 *
 * Data provider
 *
 * Provides various post_args to induce error messages in the that can be
 * compared to the expected_results.
 *
 * @see test_ajax_load_available_items_error_messages
 *
 * @since 4.3
 *
 * @return array {
 *      @type array $post_args        The arguments that will merged with the $_POST array.
 *      @type array $expected_results The expected results from the ajax call
 * }
 *
 */