From c55fba8ab2a1c9d3df65eda4a5a1e957f4aa1f78 Mon Sep 17 00:00:00 2001
From: Andrew Lee <alee14498@protonmail.com>
Date: Sun, 19 Apr 2020 17:19:32 -0400
Subject: Inital commit

---
 .../reference-tests-monobehaviour.md               | 51 ++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-tests-monobehaviour.md

(limited to 'Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-tests-monobehaviour.md')

diff --git a/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-tests-monobehaviour.md b/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-tests-monobehaviour.md
new file mode 100644
index 0000000..13959d5
--- /dev/null
+++ b/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-tests-monobehaviour.md
@@ -0,0 +1,51 @@
+# MonoBehaviour tests
+
+`MonoBehaviourTest` is a [coroutine](https://docs.unity3d.com/ScriptReference/Coroutine.html) and a helper for writing [MonoBehaviour](https://docs.unity3d.com/ScriptReference/MonoBehaviour.html) tests. 
+
+Yield a `MonoBehaviourTest` when using the `UnityTest` attribute to instantiate the `MonoBehaviour` you wish to test and wait for it to finish running. Implement the `IMonoBehaviourTest` interface on the `MonoBehaviour` to state when the test completes.
+
+## Example
+
+```c#
+[UnityTest]
+public IEnumerator MonoBehaviourTest_Works()
+{
+    yield return new MonoBehaviourTest<MyMonoBehaviourTest>();
+}
+
+public class MyMonoBehaviourTest : MonoBehaviour, IMonoBehaviourTest
+{
+    private int frameCount;
+    public bool IsTestFinished
+    {
+        get { return frameCount > 10; }
+    }
+
+     void Update()
+     {
+        frameCount++;
+     }
+}
+```
+
+## MonoBehaviourTest&lt;T&gt;
+
+This is a wrapper that allows running tests on `MonoBehaviour` scripts. Inherits from [CustomYieldInstruction](https://docs.unity3d.com/ScriptReference/CustomYieldInstruction.html).
+
+### Properties
+
+| Syntax                  | Description                                                  |
+| ----------------------- | ------------------------------------------------------------ |
+| `T component`           | A `MonoBehaviour` component created for the test and attached to the test’s [GameObject](https://docs.unity3d.com/ScriptReference/GameObject.html). |
+| `GameObject gameObject` | A `GameObject` created as a container for the test component. |
+| `bool keepWaiting`      | (Inherited) Returns `true` if the test is not finished yet, which keeps the coroutine suspended. |
+
+## IMonoBehaviourTest
+
+An interface implemented by a `MonoBehaviour` test.
+
+### Properties
+
+| Syntax                | Description                                     |
+| --------------------- | ----------------------------------------------- |
+| `bool IsTestFinished` | Indicates when the test is considered finished. |
\ No newline at end of file
-- 
cgit v1.2.3