From 101a250b45d5cebc489b55ad1633e612e2e5db85 Mon Sep 17 00:00:00 2001
From: GitHub Actions <>
Date: Tue, 4 Apr 2023 10:02:28 +0000
Subject: [PATCH] Update phpdoc
---
docs/classes/README.md | 4 +-
docs/classes/Service/InstallationService.md | 64 ++++++++++++++++-----
docs/classes/Service/PetStoreService.md | 37 +++++++++---
3 files changed, 79 insertions(+), 26 deletions(-)
diff --git a/docs/classes/README.md b/docs/classes/README.md
index cc402ea..fdded44 100644
--- a/docs/classes/README.md
+++ b/docs/classes/README.md
@@ -1,4 +1,4 @@
# CommonGateway\PetStoreBundle
-* [Service\InstallationService](Service/InstallationService.md)
-* [Service\PetStoreService](Service/PetStoreService.md)
+* [Service\InstallationService](Service/InstallationService.md)
+* [Service\PetStoreService](Service/PetStoreService.md)
diff --git a/docs/classes/Service/InstallationService.md b/docs/classes/Service/InstallationService.md
index 34a726b..073c73d 100644
--- a/docs/classes/Service/InstallationService.md
+++ b/docs/classes/Service/InstallationService.md
@@ -1,20 +1,26 @@
-# CommonGateway\PetStoreBundle\Service\InstallationService
+# CommonGateway\PetStoreBundle\Service\InstallationService
+
-## Implements:
+## Implements:
CommonGateway\CoreBundle\Installer\InstallerInterface
+
+
## Methods
| Name | Description |
|------|-------------|
-|[\_\_construct](#installationservice__construct)|The constructor|
+|[__construct](#installationservice__construct)|The constructor|
|[checkDataConsistency](#installationservicecheckdataconsistency)|The actual code run on update and installation of this bundle|
|[install](#installationserviceinstall)|Every installation service should implement an install function|
|[uninstall](#installationserviceuninstall)|Every installation service should implement an uninstall function|
|[update](#installationserviceupdate)|Every installation service should implement an update function|
-### InstallationService::\_\_construct
+
+
+
+### InstallationService::__construct
**Description**
@@ -22,20 +28,24 @@ CommonGateway\CoreBundle\Installer\InstallerInterface
public __construct (\EntityManagerInterface $entityManager)
```
-The constructor
+The constructor
+
+
**Parameters**
-* `(\EntityManagerInterface) $entityManager`
- : The entity manager
+* `(\EntityManagerInterface) $entityManager`
+: The entity manager
**Return Values**
`void`
+
-### InstallationService::checkDataConsistency
+
+### InstallationService::checkDataConsistency
**Description**
@@ -43,7 +53,9 @@ The constructor
public checkDataConsistency (void)
```
-The actual code run on update and installation of this bundle
+The actual code run on update and installation of this bundle
+
+
**Parameters**
@@ -53,9 +65,13 @@ The actual code run on update and installation of this bundle
`void`
+
+
+
-### InstallationService::install
+
+### InstallationService::install
**Description**
@@ -63,7 +79,9 @@ The actual code run on update and installation of this bundle
public install (void)
```
-Every installation service should implement an install function
+Every installation service should implement an install function
+
+
**Parameters**
@@ -73,9 +91,13 @@ Every installation service should implement an install function
`void`
+
+
+
-### InstallationService::uninstall
+
+### InstallationService::uninstall
**Description**
@@ -83,7 +105,9 @@ Every installation service should implement an install function
public uninstall (void)
```
-Every installation service should implement an uninstall function
+Every installation service should implement an uninstall function
+
+
**Parameters**
@@ -93,9 +117,13 @@ Every installation service should implement an uninstall function
`void`
+
+
+
-### InstallationService::update
+
+### InstallationService::update
**Description**
@@ -103,7 +131,9 @@ Every installation service should implement an uninstall function
public update (void)
```
-Every installation service should implement an update function
+Every installation service should implement an update function
+
+
**Parameters**
@@ -113,4 +143,8 @@ Every installation service should implement an update function
`void`
+
+
+
+
diff --git a/docs/classes/Service/PetStoreService.md b/docs/classes/Service/PetStoreService.md
index 659c277..6367012 100644
--- a/docs/classes/Service/PetStoreService.md
+++ b/docs/classes/Service/PetStoreService.md
@@ -1,13 +1,22 @@
-# CommonGateway\PetStoreBundle\Service\PetStoreService
+# CommonGateway\PetStoreBundle\Service\PetStoreService
+
+
+
+
+
+
## Methods
| Name | Description |
|------|-------------|
-|[\_\_construct](#petstoreservice__construct)||
+|[__construct](#petstoreservice__construct)||
|[petStoreHandler](#petstoreservicepetstorehandler)|An example handler that is triggered by an action.|
-### PetStoreService::\_\_construct
+
+
+
+### PetStoreService::__construct
**Description**
@@ -15,6 +24,10 @@
__construct (void)
```
+
+
+
+
**Parameters**
`This function has no parameters.`
@@ -23,9 +36,11 @@
`void`
+
-### PetStoreService::petStoreHandler
+
+### PetStoreService::petStoreHandler
**Description**
@@ -33,14 +48,16 @@
public petStoreHandler (array $data, array $configuration)
```
-An example handler that is triggered by an action.
+An example handler that is triggered by an action.
+
+
**Parameters**
-* `(array) $data`
- : The data array
-* `(array) $configuration`
- : The configuration array
+* `(array) $data`
+: The data array
+* `(array) $configuration`
+: The configuration array
**Return Values**
@@ -48,4 +65,6 @@ An example handler that is triggered by an action.
> A handler must ALWAYS return an array
+
+