From c9d806db9d3366be2807dcfd2e43a3e0e128a9ee Mon Sep 17 00:00:00 2001 From: Jesse Donat Date: Mon, 30 Aug 2021 15:30:59 -0500 Subject: [PATCH] Very slight docs improvments --- docs/docs.md | 14 +++++++++++++- mddoc.xml | 4 ++++ src/Responses/DefaultResponse.php | 4 ++++ src/Responses/NotFoundResponse.php | 3 +++ 4 files changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/docs.md b/docs/docs.md index b7282ac..707371b 100644 --- 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` \ No newline at end of file +- ***\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 \ No newline at end of file diff --git a/mddoc.xml b/mddoc.xml index 2584d7d..e75b67f 100644 --- a/mddoc.xml +++ b/mddoc.xml @@ -28,6 +28,10 @@ I would be happy to accept pull requests that correct this. +
+ + +
diff --git a/src/Responses/DefaultResponse.php b/src/Responses/DefaultResponse.php index ff57654..0687df3 100644 --- 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 index 73fdbee..7b6cf40 100644 --- 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() {