Changeset 40968 for trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php

Timestamp:

06/30/2017 04:35:39 AM (9 years ago)

Author:

DrewAPicture

Message:

Tests: Add @method notations to factor class DocBlocks as a way to indicate expected return types from factory methods for the benefit of IDEs.

Props jdgrimes.
Fixes #37867.

File:

• trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php (modified) (2 diffs)

trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php

@@ -1 +1 @@
 <?php
 
+/**
+ * Unit test factory for terms.
+ *
+ * Note: The below @method notations are defined solely for the benefit of IDEs,
+ * as a way to indicate expected return values from the given factory methods.
+ *
+ * @method int create( $args = array(), $generation_definitions = null )
+ * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
+ */
 class WP_UnitTest_Factory_For_Term extends WP_UnitTest_Factory_For_Thing {
 
@@ -36 +45 @@
     }
 
+    /**
+     * @return array|null|WP_Error|WP_Term
+     */
     function create_and_get( $args = array(), $generation_definitions = null ) {
         $term_id = $this->create( $args, $generation_definitions );