Very slight docs improvments

donatj · Aug 30, 2021 · c9d806d · c9d806d
1 parent a40ab97
commit c9d806d
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 1 deletion.
diff --git a/docs/docs.md b/docs/docs.md
@@ -291,4 +291,16 @@ Set the Response for the Given Method
 #### Parameters:
 
 - ***string*** `$method`
-- ***\donatj\MockWebServer\ResponseInterface*** `$response`
+- ***\donatj\MockWebServer\ResponseInterface*** `$response`
+
+## Built-In Responses
+
+### Class: \donatj\MockWebServer\Responses\DefaultResponse
+
+The Built-In Default Response.
+
+Results in an HTTP 200 with a JSON encoded version of the incoming Request
+
+### Class: \donatj\MockWebServer\Responses\NotFoundResponse
+
+Basic Built-In 404 Response
diff --git a/mddoc.xml b/mddoc.xml
@@ -28,6 +28,10 @@ I would be happy to accept pull requests that correct this.
 						<file name="src/Response.php"/>
 						<file name="src/ResponseStack.php"/>
 						<file name="src/ResponseByMethod.php"/>
+						<section title="Built-In Responses">
+							<file name="src/Responses/DefaultResponse.php"/>
+							<file name="src/Responses/NotFoundResponse.php"/>
+						</section>
 					</section>
 				</docpage>
 			</section>

diff --git a/src/Responses/DefaultResponse.php b/src/Responses/DefaultResponse.php
@@ -6,6 +6,10 @@
 use donatj\MockWebServer\RequestInfo;
 use donatj\MockWebServer\ResponseInterface;
 
+/**
+ * The Built-In Default Response.
+ * Results in an HTTP 200 with a JSON encoded version of the incoming Request
+ */
 class DefaultResponse implements ResponseInterface {
 
 	public function getRef() {

diff --git a/src/Responses/NotFoundResponse.php b/src/Responses/NotFoundResponse.php
@@ -6,6 +6,9 @@
 use donatj\MockWebServer\RequestInfo;
 use donatj\MockWebServer\ResponseInterface;
 
+/**
+ * Basic Built-In 404 Response
+ */
 class NotFoundResponse implements ResponseInterface {
 
 	public function getRef() {