diff options
| author | Fabien Potencier <fabien.potencier@gmail.com> | 2014-11-30 17:59:09 +0100 |
|---|---|---|
| committer | Fabien Potencier <fabien.potencier@gmail.com> | 2014-11-30 17:59:09 +0100 |
| commit | f9c498153d663c0cf0710ff9c89a11d2a4833cdc (patch) | |
| tree | fe2c86b4887eef95757f849324e26d20965766bc /Acl/Permission | |
| parent | 748e258f7683a17e9803ded49ae94ab3e24e6c68 (diff) | |
| parent | e5dfe6a3e96c71e87c0ca9aa84115accd9ebb229 (diff) | |
| download | symfony-security-f9c498153d663c0cf0710ff9c89a11d2a4833cdc.zip symfony-security-f9c498153d663c0cf0710ff9c89a11d2a4833cdc.tar.gz symfony-security-f9c498153d663c0cf0710ff9c89a11d2a4833cdc.tar.bz2 | |
minor #12774 Docblock Fixes (GrahamCampbell)
This PR was merged into the 2.3 branch.
Discussion
----------
Docblock Fixes
| Q | A
| ------------- | ---
| Bug fix? | no
| New feature? | no
| BC breaks? | no
| Deprecations? | no
| Tests pass? | yes
| Fixed tickets | N/A
| License | MIT
| Doc PR | N/A
##### This pull request fixes the docblock alignment as requested in #12760.
It was also necessary for me to ensure the `@return` annotations were correctly separated in order to accurately align the `@param` annotations.
Commits
-------
443307e Docblock fixes
Diffstat (limited to 'Acl/Permission')
| -rw-r--r-- | Acl/Permission/MaskBuilder.php | 6 | ||||
| -rw-r--r-- | Acl/Permission/PermissionMapInterface.php | 2 |
2 files changed, 6 insertions, 2 deletions
diff --git a/Acl/Permission/MaskBuilder.php b/Acl/Permission/MaskBuilder.php index bcf03c5..89cfd39 100644 --- a/Acl/Permission/MaskBuilder.php +++ b/Acl/Permission/MaskBuilder.php @@ -72,7 +72,7 @@ class MaskBuilder /** * Constructor * - * @param int $mask optional; defaults to 0 + * @param int $mask optional; defaults to 0 * * @throws \InvalidArgumentException */ @@ -178,9 +178,11 @@ class MaskBuilder /** * Returns the code for the passed mask * - * @param int $mask + * @param int $mask + * * @throws \InvalidArgumentException * @throws \RuntimeException + * * @return string */ public static function getCode($mask) diff --git a/Acl/Permission/PermissionMapInterface.php b/Acl/Permission/PermissionMapInterface.php index 20ca181..1b2a7fd 100644 --- a/Acl/Permission/PermissionMapInterface.php +++ b/Acl/Permission/PermissionMapInterface.php @@ -26,6 +26,7 @@ interface PermissionMapInterface * * @param string $permission * @param object $object + * * @return array may return null if permission/object combination is not supported */ public function getMasks($permission, $object); @@ -34,6 +35,7 @@ interface PermissionMapInterface * Whether this map contains the given permission * * @param string $permission + * * @return bool */ public function contains($permission); |