[wp-trac] [WordPress Trac] #37867: Document return types for create/create_and_get/create_many() methods of factory classes

[WordPress Trac]

#37867: Document return types for create/create_and_get/create_many() methods of
factory classes
------------------------------+-----------------------------
 Reporter:  jdgrimes          |      Owner:
     Type:  enhancement       |     Status:  new
 Priority:  normal            |  Milestone:  Awaiting Review
Component:  Build/Test Tools  |    Version:  3.7
 Severity:  normal            |   Keywords:
  Focuses:  docs              |
------------------------------+-----------------------------
 The `create()`, `create_and_get()`, and `create_many()` methods are
 defined on the base factory class, and use other methods that are defined
 as abstract and implemented by the child classes. So just documenting the
 return types of the child class methods isn't really that helpful, and
 probably won't be picked up by IDEs. But by using `@method` annotations in
 the class-level docblocks for each of the factories we can provide this
 information in a form that will be helpful to those of use who use
 intelligent IDEs, as well as any developer who is new to the tests.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/37867>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform