Add documentions

2.x 2.3.0
Julien Rosset 3 years ago
parent ea3d2faf30
commit e9f05334fc

@ -4,6 +4,9 @@ namespace jrosset\EnvReader;
use Exception; use Exception;
/**
* A ENV file configuration class
*/
abstract class EnvConfig extends GenericConfig implements IExternalConfigFile { abstract class EnvConfig extends GenericConfig implements IExternalConfigFile {
/** /**
* @inheritDoc * @inheritDoc

@ -13,7 +13,7 @@ use RangeException;
use UnexpectedValueException; use UnexpectedValueException;
/** /**
* Utility class to get informations from ENV file * A generic configuration class
* *
* Overwrite {@see GenericConfig::initialProperties()} to set initial properties * Overwrite {@see GenericConfig::initialProperties()} to set initial properties
*/ */

@ -3,7 +3,7 @@
namespace jrosset\EnvReader; namespace jrosset\EnvReader;
/** /**
* Interface for config based on an external file * Interface for external file based configurations
*/ */
interface IExternalConfigFile { interface IExternalConfigFile {
/** /**

@ -5,6 +5,9 @@ namespace jrosset\EnvReader;
use Exception; use Exception;
use jrosset\ArrayClasses\InsensitiveCaseArrayClass; use jrosset\ArrayClasses\InsensitiveCaseArrayClass;
/**
* A INI file configuration class
*/
abstract class IniConfig extends GenericConfig implements IExternalConfigFile { abstract class IniConfig extends GenericConfig implements IExternalConfigFile {
use TMultiLevelProperties; use TMultiLevelProperties;

Loading…
Cancel
Save