Skip to content

Commit 5f089e2

Browse files
Fixed phpdoc
1 parent 637718b commit 5f089e2

File tree

3 files changed

+21
-20
lines changed

3 files changed

+21
-20
lines changed

src/Dotenv.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
namespace Dotenv;
44

55
/**
6-
* Dotenv.
6+
* This is the dotenv class.
77
*
8-
* Loads a `.env` file in the given directory and sets the environment vars.
8+
* It's responsible for loading a `.env` file in the given directory and
9+
* setting the environment vars.
910
*/
1011
class Dotenv
1112
{

src/Loader.php

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
use Dotenv\Exception\InvalidPathException;
77

88
/**
9-
* Loader.
9+
* This is the loaded class.
1010
*
11-
* Loads Variables by reading a file from disk and:
12-
* - stripping comments beginning with a `#`
13-
* - parsing lines that look shell variable setters, e.g `export key = value`, `key="value"`
11+
* It's responsible for loading variables by reading a file from disk and:
12+
* - stripping comments beginning with a `#`,
13+
* - parsing lines that look shell variable setters, e.g `export key = value`, `key="value"`.
1414
*/
1515
class Loader
1616
{
@@ -88,13 +88,13 @@ protected function ensureFileIsReadable()
8888
* Normalise the given environment variable.
8989
*
9090
* Takes value as passed in by developer and:
91-
* - ensures we're dealing with a separate name and value, breaking apart the name string if needed
92-
* - cleaning the value of quotes
93-
* - cleaning the name of quotes
94-
* - resolving nested variables
91+
* - ensures we're dealing with a separate name and value, breaking apart the name string if needed,
92+
* - cleaning the value of quotes,
93+
* - cleaning the name of quotes,
94+
* - resolving nested variables.
9595
*
96-
* @param $name
97-
* @param $value
96+
* @param string $name
97+
* @param string $value
9898
*
9999
* @return array
100100
*/
@@ -245,7 +245,7 @@ protected function sanitiseVariableValue($name, $value)
245245
* Look for {$varname} patterns in the variable value and replace with an existing
246246
* environment variable.
247247
*
248-
* @param $value
248+
* @param string $value
249249
*
250250
* @return mixed
251251
*/
@@ -321,13 +321,13 @@ public function getEnvironmentVariable($name)
321321
* Set an environment variable.
322322
*
323323
* This is done using:
324-
* - putenv
325-
* - $_ENV
324+
* - putenv,
325+
* - $_ENV,
326326
* - $_SERVER.
327327
*
328328
* The environment variable value is stripped of single and double quotes.
329329
*
330-
* @param $name
330+
* @param string $name
331331
* @param string|null $value
332332
*
333333
* @return void
@@ -354,8 +354,8 @@ public function setEnvironmentVariable($name, $value = null)
354354
* method for 3rd party code.
355355
*
356356
* This is done using:
357-
* - putenv
358-
* - unset($_ENV, $_SERVER)
357+
* - putenv,
358+
* - unset($_ENV, $_SERVER).
359359
*
360360
* @param string $name
361361
*

src/Validator.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
use Dotenv\Exception\InvalidPathException;
77

88
/**
9-
* Validator.
9+
* This is the validator class.
1010
*
11-
* Validations to be applied against a number of variables.
11+
* It's responsible for applying validations against a number of variables.
1212
*/
1313
class Validator
1414
{

0 commit comments

Comments
 (0)