From d0cf8ad6a05fc736ee0622a2fb6641ddc5fde61c Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Tue, 25 Apr 2023 08:45:36 +0000 Subject: [PATCH] Update src from remark-lint --- docs/classes/README.md | 4 +- docs/classes/Service/InstallationService.md | 68 ++++++--------------- docs/classes/Service/PetStoreService.md | 37 +++-------- 3 files changed, 28 insertions(+), 81 deletions(-) diff --git a/docs/classes/README.md b/docs/classes/README.md index fdded44..cc402ea 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 03957bf..19413bc 100644 --- a/docs/classes/Service/InstallationService.md +++ b/docs/classes/Service/InstallationService.md @@ -1,26 +1,20 @@ -# CommonGateway\PetStoreBundle\Service\InstallationService - - +# CommonGateway\PetStoreBundle\Service\InstallationService ## Implements: -CommonGateway\CoreBundle\Installer\InstallerInterface - +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** @@ -28,26 +22,22 @@ CommonGateway\CoreBundle\Installer\InstallerInterface 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` -
- -### InstallationService::checkDataConsistency +### InstallationService::checkDataConsistency **Description** @@ -55,9 +45,7 @@ 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** @@ -67,13 +55,9 @@ The actual code run on update and installation of this bundle `void` - - -
- -### InstallationService::install +### InstallationService::install **Description** @@ -81,9 +65,7 @@ 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** @@ -93,13 +75,9 @@ Every installation service should implement an install function `void` - - -
- -### InstallationService::uninstall +### InstallationService::uninstall **Description** @@ -107,9 +85,7 @@ 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** @@ -119,13 +95,9 @@ Every installation service should implement an uninstall function `void` - - -
- -### InstallationService::update +### InstallationService::update **Description** @@ -133,9 +105,7 @@ 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** @@ -145,8 +115,4 @@ Every installation service should implement an update function `void` - - -
- diff --git a/docs/classes/Service/PetStoreService.md b/docs/classes/Service/PetStoreService.md index 6367012..659c277 100644 --- a/docs/classes/Service/PetStoreService.md +++ b/docs/classes/Service/PetStoreService.md @@ -1,22 +1,13 @@ -# 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** @@ -24,10 +15,6 @@ __construct (void) ``` - - - - **Parameters** `This function has no parameters.` @@ -36,11 +23,9 @@ `void` -
- -### PetStoreService::petStoreHandler +### PetStoreService::petStoreHandler **Description** @@ -48,16 +33,14 @@ 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** @@ -65,6 +48,4 @@ An example handler that is triggered by an action. > A handler must ALWAYS return an array -
-