From e01d3e1e5919f9bc53d84bc598d4e811f8b2a136 Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Sun, 9 Dec 2018 22:20:41 +0100 Subject: [PATCH] Fix doc align --- .../Cache/Connection/ConnectionInterface.php | 2 +- DataStorage/Database/DataMapperAbstract.php | 2 +- DataStorage/Database/Query/Builder.php | 8 ++-- Message/RequestAbstract.php | 2 +- Module/ModuleAbstract.php | 38 +++++++++---------- Stdlib/Base/Iban.php | 6 +-- Stdlib/Base/Location.php | 6 +-- Stdlib/Queue/PriorityQueue.php | 14 +++---- System/File/Ftp/Directory.php | 6 +-- System/File/Ftp/File.php | 4 +- System/File/Local/File.php | 4 +- Utils/StringUtils.php | 2 +- Utils/TaskSchedule/TaskAbstract.php | 2 +- Views/View.php | 2 +- 14 files changed, 49 insertions(+), 49 deletions(-) diff --git a/DataStorage/Cache/Connection/ConnectionInterface.php b/DataStorage/Cache/Connection/ConnectionInterface.php index 552840b7b..9ad0f9811 100644 --- a/DataStorage/Cache/Connection/ConnectionInterface.php +++ b/DataStorage/Cache/Connection/ConnectionInterface.php @@ -102,7 +102,7 @@ interface ConnectionInterface extends DataStorageConnectionInterface * * @param mixed $key Unique cache key * @param mixed $value Cache value - * @param int $expire Valid duration (in s) + * @param int $expire Valid duration (in s) * * @return bool * diff --git a/DataStorage/Database/DataMapperAbstract.php b/DataStorage/Database/DataMapperAbstract.php index b52612018..f79c156fe 100644 --- a/DataStorage/Database/DataMapperAbstract.php +++ b/DataStorage/Database/DataMapperAbstract.php @@ -1162,7 +1162,7 @@ class DataMapperAbstract implements DataMapperInterface * The reference is stored in the main model * * @param string $propertyName Property name to initialize - * @param array $obj Object to update + * @param array $obj Object to update * @param int $relations Create all relations as well * @param int $depth Depth of relations to update (default = 1 = none) * diff --git a/DataStorage/Database/Query/Builder.php b/DataStorage/Database/Query/Builder.php index 119334759..7ccc2a1cb 100644 --- a/DataStorage/Database/Query/Builder.php +++ b/DataStorage/Database/Query/Builder.php @@ -347,7 +347,7 @@ class Builder extends BuilderAbstract /** * Set raw query. * - * @param string $raw Raw query + * @param string $raw Raw query * * @return Builder * @@ -371,7 +371,7 @@ class Builder extends BuilderAbstract * Tests if a string contains a non read only component in case the builder is read only. * If the builder is not read only it will always return true * - * @param string $raw Raw query + * @param string $raw Raw query * * @return bool * @@ -923,7 +923,7 @@ class Builder extends BuilderAbstract /** * Values to insert. * - * @param mixed $value Values + * @param mixed $value Values * * @return Builder * @@ -964,7 +964,7 @@ class Builder extends BuilderAbstract /** * Values to insert. * - * @param mixed $set Values + * @param mixed $set Values * * @return Builder * diff --git a/Message/RequestAbstract.php b/Message/RequestAbstract.php index e9ddb0d2b..edfca85ec 100644 --- a/Message/RequestAbstract.php +++ b/Message/RequestAbstract.php @@ -196,7 +196,7 @@ abstract class RequestAbstract implements MessageInterface /** * Get data. * - * @param mixed $key Data key + * @param mixed $key Data key * @param string $delim Data delimiter * * @return array diff --git a/Module/ModuleAbstract.php b/Module/ModuleAbstract.php index 643e2a505..d80ecab2b 100644 --- a/Module/ModuleAbstract.php +++ b/Module/ModuleAbstract.php @@ -238,10 +238,10 @@ abstract class ModuleAbstract /** * Create a model * - * @param RequestAbstract $request Request - * @param mixed $obj Response object - * @param string $mapper Object mapper - * @param string $trigger Trigger for the event manager + * @param RequestAbstract $request Request + * @param mixed $obj Response object + * @param string $mapper Object mapper + * @param string $trigger Trigger for the event manager * * @return void * @@ -261,11 +261,11 @@ abstract class ModuleAbstract /** * Update a model * - * @param RequestAbstract $request Request - * @param mixed $old Response object old - * @param mixed $new Response object new - * @param string|\Closure $mapper Object mapper - * @param string $trigger Trigger for the event manager + * @param RequestAbstract $request Request + * @param mixed $old Response object old + * @param mixed $new Response object new + * @param string|\Closure $mapper Object mapper + * @param string $trigger Trigger for the event manager * * @return void * @@ -289,10 +289,10 @@ abstract class ModuleAbstract /** * Delete a model * - * @param RequestAbstract $request Request - * @param mixed $obj Response object - * @param string $mapper Object mapper - * @param string $trigger Trigger for the event manager + * @param RequestAbstract $request Request + * @param mixed $obj Response object + * @param string $mapper Object mapper + * @param string $trigger Trigger for the event manager * * @return void * @@ -312,12 +312,12 @@ abstract class ModuleAbstract /** * Create a model relation * - * @param RequestAbstract $request Request - * @param mixed $rel1 Response object relation1 - * @param mixed $rel2 Response object relation2 - * @param string $mapper Object mapper - * @param string $field Relation field - * @param string $trigger Trigger for the event manager + * @param RequestAbstract $request Request + * @param mixed $rel1 Response object relation1 + * @param mixed $rel2 Response object relation2 + * @param string $mapper Object mapper + * @param string $field Relation field + * @param string $trigger Trigger for the event manager * * @return void * diff --git a/Stdlib/Base/Iban.php b/Stdlib/Base/Iban.php index a42024c7f..33cdf52c5 100644 --- a/Stdlib/Base/Iban.php +++ b/Stdlib/Base/Iban.php @@ -274,9 +274,9 @@ class Iban implements \Serializable /** * Constructs the object * @link http://php.net/manual/en/serializable.unserialize.php - * @param string $serialized

- * The string representation of the object. - *

+ * @param string $serialized

+ * The string representation of the object. + *

* @return void * @since 5.1.0 */ diff --git a/Stdlib/Base/Location.php b/Stdlib/Base/Location.php index 28f90a46f..c418bf8d1 100644 --- a/Stdlib/Base/Location.php +++ b/Stdlib/Base/Location.php @@ -326,9 +326,9 @@ class Location implements \JsonSerializable, \Serializable /** * Constructs the object * @link http://php.net/manual/en/serializable.unserialize.php - * @param string $serialized

- * The string representation of the object. - *

+ * @param string $serialized

+ * The string representation of the object. + *

* @return void * @since 5.1.0 */ diff --git a/Stdlib/Queue/PriorityQueue.php b/Stdlib/Queue/PriorityQueue.php index 33dd2e370..0e30b1a5e 100644 --- a/Stdlib/Queue/PriorityQueue.php +++ b/Stdlib/Queue/PriorityQueue.php @@ -65,8 +65,8 @@ class PriorityQueue implements \Countable, \Serializable /** * Insert element into queue. * - * @param mixed $data Queue element - * @param float $priority Priority of this element + * @param mixed $data Queue element + * @param float $priority Priority of this element * * @return int * @@ -94,7 +94,7 @@ class PriorityQueue implements \Countable, \Serializable /** * Get insert position * - * @param float $priority Priority of new element + * @param float $priority Priority of new element * * @return int * @@ -119,7 +119,7 @@ class PriorityQueue implements \Countable, \Serializable /** * Get insert position * - * @param float $priority Priority of new element + * @param float $priority Priority of new element * * @return int * @@ -133,7 +133,7 @@ class PriorityQueue implements \Countable, \Serializable /** * Get insert position * - * @param float $priority Priority of new element + * @param float $priority Priority of new element * * @return int * @@ -147,7 +147,7 @@ class PriorityQueue implements \Countable, \Serializable /** * Get insert position * - * @param float $priority Priority of new element + * @param float $priority Priority of new element * * @return int * @@ -170,7 +170,7 @@ class PriorityQueue implements \Countable, \Serializable /** * Get insert position * - * @param float $priority Priority of new element + * @param float $priority Priority of new element * * @return int * diff --git a/System/File/Ftp/Directory.php b/System/File/Ftp/Directory.php index 90a607cae..213ce51ea 100644 --- a/System/File/Ftp/Directory.php +++ b/System/File/Ftp/Directory.php @@ -344,9 +344,9 @@ class Directory extends FileAbstract implements DirectoryInterface /** * Offset to retrieve * @link http://php.net/manual/en/arrayaccess.offsetget.php - * @param mixed $offset

- * The offset to retrieve. - *

+ * @param mixed $offset

+ * The offset to retrieve. + *

* @return mixed Can return all value types. * @since 5.0.0 */ diff --git a/System/File/Ftp/File.php b/System/File/Ftp/File.php index c06b0a5e8..6ea9b48ab 100644 --- a/System/File/Ftp/File.php +++ b/System/File/Ftp/File.php @@ -296,7 +296,7 @@ class File extends FileAbstract implements FileInterface /** * Gets the directory name of a file. * - * @param string $path Path of the file to get the directory name for. + * @param string $path Path of the file to get the directory name for. * * @return string Returns the directory name of the file. * @@ -310,7 +310,7 @@ class File extends FileAbstract implements FileInterface /** * Gets the directory path of a file. * - * @param string $path Path of the file to get the directory name for. + * @param string $path Path of the file to get the directory name for. * * @return string Returns the directory name of the file. * diff --git a/System/File/Local/File.php b/System/File/Local/File.php index 7fe8da7e2..6a196f95c 100644 --- a/System/File/Local/File.php +++ b/System/File/Local/File.php @@ -243,7 +243,7 @@ final class File extends FileAbstract implements FileInterface /** * Gets the directory name of a file. * - * @param string $path Path of the file to get the directory name for. + * @param string $path Path of the file to get the directory name for. * * @return string Returns the directory name of the file. * @@ -257,7 +257,7 @@ final class File extends FileAbstract implements FileInterface /** * Gets the directory path of a file. * - * @param string $path Path of the file to get the directory name for. + * @param string $path Path of the file to get the directory name for. * * @return string Returns the directory name of the file. * diff --git a/Utils/StringUtils.php b/Utils/StringUtils.php index aa597bcfe..df32fb91b 100644 --- a/Utils/StringUtils.php +++ b/Utils/StringUtils.php @@ -46,7 +46,7 @@ final class StringUtils * * The validation is done case sensitive. * - * @param string $haystack Haystack + * @param string $haystack Haystack * @param array $needles Needles to check if any of them are part of the haystack * * @example StringUtils::contains('This string', ['This', 'test']); // true diff --git a/Utils/TaskSchedule/TaskAbstract.php b/Utils/TaskSchedule/TaskAbstract.php index 5a7028c6a..c663b81f7 100644 --- a/Utils/TaskSchedule/TaskAbstract.php +++ b/Utils/TaskSchedule/TaskAbstract.php @@ -76,7 +76,7 @@ abstract class TaskAbstract * Comment * * @param string $name Name of the task - * @param string $cmd Command/script to run + * @param string $cmd Command/script to run * * @var string * @since 1.0.0 diff --git a/Views/View.php b/Views/View.php index 466fcfa06..f935874e4 100644 --- a/Views/View.php +++ b/Views/View.php @@ -168,7 +168,7 @@ class View extends ViewAbstract * @return string * * @throws InvalidModuleException Throws this exception if no data for the defined module could be found. - * @throws InvalidThemeException Throws this exception if no data for the defined theme could be found. + * @throws InvalidThemeException Throws this exception if no data for the defined theme could be found. * * @since 1.0.0 */