From e9f05334fcfa2eead7a81e94476e57a5186b2089 Mon Sep 17 00:00:00 2001 From: Julien Rosset Date: Thu, 20 Oct 2022 19:18:09 +0200 Subject: [PATCH] Add documentions --- src/EnvReader/EnvConfig.php | 3 +++ src/EnvReader/GenericConfig.php | 2 +- src/EnvReader/IExternalConfigFile.php | 2 +- src/EnvReader/IniConfig.php | 3 +++ 4 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/EnvReader/EnvConfig.php b/src/EnvReader/EnvConfig.php index 22282cb..2b1a41d 100644 --- a/src/EnvReader/EnvConfig.php +++ b/src/EnvReader/EnvConfig.php @@ -4,6 +4,9 @@ namespace jrosset\EnvReader; use Exception; +/** + * A ENV file configuration class + */ abstract class EnvConfig extends GenericConfig implements IExternalConfigFile { /** * @inheritDoc diff --git a/src/EnvReader/GenericConfig.php b/src/EnvReader/GenericConfig.php index bedc510..d2c7ad3 100644 --- a/src/EnvReader/GenericConfig.php +++ b/src/EnvReader/GenericConfig.php @@ -13,7 +13,7 @@ use RangeException; use UnexpectedValueException; /** - * Utility class to get informations from ENV file + * A generic configuration class * * Overwrite {@see GenericConfig::initialProperties()} to set initial properties */ diff --git a/src/EnvReader/IExternalConfigFile.php b/src/EnvReader/IExternalConfigFile.php index 6505bd6..dd54152 100644 --- a/src/EnvReader/IExternalConfigFile.php +++ b/src/EnvReader/IExternalConfigFile.php @@ -3,7 +3,7 @@ namespace jrosset\EnvReader; /** - * Interface for config based on an external file + * Interface for external file based configurations */ interface IExternalConfigFile { /** diff --git a/src/EnvReader/IniConfig.php b/src/EnvReader/IniConfig.php index 295eb9b..c58e54e 100644 --- a/src/EnvReader/IniConfig.php +++ b/src/EnvReader/IniConfig.php @@ -5,6 +5,9 @@ namespace jrosset\EnvReader; use Exception; use jrosset\ArrayClasses\InsensitiveCaseArrayClass; +/** + * A INI file configuration class + */ abstract class IniConfig extends GenericConfig implements IExternalConfigFile { use TMultiLevelProperties;