Update phpdoc

CommonGateway · Jun 15, 2023 · 37860ce · 37860ce
1 parent 81de62e
commit 37860ce
Show file tree

Hide file tree

Showing 3 changed files with 81 additions and 28 deletions.
diff --git 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
@@ -1,51 +1,63 @@
-# 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**
 
 ```php
 public __construct (\EntityManagerInterface $entityManager, \LoggerInterface $installationLogger)
 ```
 
-The constructor
+The constructor 
+
+
 
 **Parameters**
 
-*   `(\EntityManagerInterface) $entityManager`
-    : The entity manager.
-*   `(\LoggerInterface) $installationLogger`
-    : The installation logger.
+* `(\EntityManagerInterface) $entityManager`
+: The entity manager.  
+* `(\LoggerInterface) $installationLogger`
+: The installation logger.  
 
 **Return Values**
 
 `void`
 
+
 <hr />
 
-### InstallationService::checkDataConsistency
+
+### InstallationService::checkDataConsistency  
 
 **Description**
 
 ```php
 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**
 
@@ -55,17 +67,23 @@ The actual code run on update and installation of this bundle
 
 `void`
 
+
+
+
 <hr />
 
-### InstallationService::install
+
+### InstallationService::install  
 
 **Description**
 
 ```php
 public install (void)
 ```
 
-Every installation service should implement an install function
+Every installation service should implement an install function 
+
+
 
 **Parameters**
 
@@ -75,17 +93,23 @@ Every installation service should implement an install function
 
 `void`
 
+
+
+
 <hr />
 
-### InstallationService::uninstall
+
+### InstallationService::uninstall  
 
 **Description**
 
 ```php
 public uninstall (void)
 ```
 
-Every installation service should implement an uninstall function
+Every installation service should implement an uninstall function 
+
+
 
 **Parameters**
 
@@ -95,17 +119,23 @@ Every installation service should implement an uninstall function
 
 `void`
 
+
+
+
 <hr />
 
-### InstallationService::update
+
+### InstallationService::update  
 
 **Description**
 
 ```php
 public update (void)
 ```
 
-Every installation service should implement an update function
+Every installation service should implement an update function 
+
+
 
 **Parameters**
 
@@ -115,4 +145,8 @@ Every installation service should implement an update function
 
 `void`
 
+
+
+
 <hr />
+
diff --git a/docs/classes/Service/PetStoreService.md b/docs/classes/Service/PetStoreService.md
@@ -1,20 +1,33 @@
-# 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**
 
 ```php
  __construct (void)
 ```
 
+
+
+
+
 **Parameters**
 
 `This function has no parameters.`
@@ -23,29 +36,35 @@
 
 `void`
 
+
 <hr />
 
-### PetStoreService::petStoreHandler
+
+### PetStoreService::petStoreHandler  
 
 **Description**
 
 ```php
 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**
 
 `array`
 
 > A handler must ALWAYS return an array
 
+
 <hr />
+