From 59c8ba7871099e1bcb4400dfca74107514fcf9d0 Mon Sep 17 00:00:00 2001
From: ericlewis <ericlewis@602fd350-edb4-49c9-b593-d223f7449a82>
Date: Sat, 5 Mar 2016 19:47:41 +0000
Subject: [PATCH] Build/Test Tools: Document PHP unit test classes.

Props boonebgorges.
Fixes #35494.


git-svn-id: https://develop.svn.wordpress.org/trunk@36854 602fd350-edb4-49c9-b593-d223f7449a82
---
 .../factory/class-wp-unittest-factory-for-thing.php  |  3 +++
 .../includes/factory/class-wp-unittest-factory.php   |  5 +++++
 tests/phpunit/includes/testcase.php                  | 12 ++++++++++++
 3 files changed, 20 insertions(+)

diff --git a/tests/phpunit/includes/factory/class-wp-unittest-factory-for-thing.php b/tests/phpunit/includes/factory/class-wp-unittest-factory-for-thing.php
index cf412c85e2..8e984572a8 100644
--- a/tests/phpunit/includes/factory/class-wp-unittest-factory-for-thing.php
+++ b/tests/phpunit/includes/factory/class-wp-unittest-factory-for-thing.php
@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * An abstract class that serves as a basis for all WordPress object-type factory classes.
+ */
 abstract class WP_UnitTest_Factory_For_Thing {
 
 	var $default_generation_definitions;
diff --git a/tests/phpunit/includes/factory/class-wp-unittest-factory.php b/tests/phpunit/includes/factory/class-wp-unittest-factory.php
index 836352ea32..58b0e8624c 100644
--- a/tests/phpunit/includes/factory/class-wp-unittest-factory.php
+++ b/tests/phpunit/includes/factory/class-wp-unittest-factory.php
@@ -1,5 +1,10 @@
 <?php
 
+/**
+ * A factory for making WordPress data with a cross-object type API.
+ *
+ * Tests should use this factory to generate test fixtures.
+ */
 class WP_UnitTest_Factory {
 
 	/**
diff --git a/tests/phpunit/includes/testcase.php b/tests/phpunit/includes/testcase.php
index 4d7f1154d6..ce7a7600a2 100644
--- a/tests/phpunit/includes/testcase.php
+++ b/tests/phpunit/includes/testcase.php
@@ -3,6 +3,15 @@
 require_once dirname( __FILE__ ) . '/factory.php';
 require_once dirname( __FILE__ ) . '/trac.php';
 
+/**
+ * Defines a basic fixture to run multiple tests.
+ *
+ * Resets the state of the WordPress installation before and after every test.
+ *
+ * Includes utility functions and assertions useful for testing WordPress.
+ *
+ * All WordPress unit tests should inherit from this class.
+ */
 class WP_UnitTestCase extends PHPUnit_Framework_TestCase {
 
 	protected static $forced_tickets = array();
@@ -124,6 +133,9 @@ class WP_UnitTestCase extends PHPUnit_Framework_TestCase {
 		$this->expectedDeprecated();
 	}
 
+	/**
+	 * After a test method runs, reset any state in WordPress the test method might have changed.
+	 */
 	function tearDown() {
 		global $wpdb, $wp_query, $wp, $post;
 		$wpdb->query( 'ROLLBACK' );