Correct syntax in PHPDoc of ServiceAccess

baracil · Nov 21, 2011 · 8b24a64 · 8b24a64
1 parent b5f6a20
commit 8b24a64
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 29 deletions.
diff --git a/ServiceAccess/ServiceAccess/ClassLoader.php b/ServiceAccess/ServiceAccess/ClassLoader.php
@@ -1,36 +1,37 @@
 <?php
-/*
+/**
-    Copyright (c) 2011, Bastien Aracil
+ *   @copyright Copyright (c) 2011, Bastien Aracil
-    All rights reserved.
+ *   All rights reserved.
-    New BSD license. See http://en.wikipedia.org/wiki/Bsd_license
+ *   New BSD license. See http://en.wikipedia.org/wiki/Bsd_license
-
+ *
-    Redistribution and use in source and binary forms, with or without
+ *   Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions are met:
+ *   modification, are permitted provided that the following conditions are met:
-       * Redistributions of source code must retain the above copyright
+ *      * Redistributions of source code must retain the above copyright
-         notice, this list of conditions and the following disclaimer.
+ *        notice, this list of conditions and the following disclaimer.
-       * Redistributions in binary form must reproduce the above copyright
+ *      * Redistributions in binary form must reproduce the above copyright
-         notice, this list of conditions and the following disclaimer in the
+ *        notice, this list of conditions and the following disclaimer in the
-         documentation and/or other materials provided with the distribution.
+ *        documentation and/or other materials provided with the distribution.
-       * The name of Bastien Aracil may not be used to endorse or promote products
+ *      * The name of Bastien Aracil may not be used to endorse or promote products
-         derived from this software without specific prior written permission.
+ *        derived from this software without specific prior written permission.
-
+ *
-    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ *   ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ *   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-    DISCLAIMED. IN NO EVENT SHALL BASTIEN ARACIL BE LIABLE FOR ANY
+ *   DISCLAIMED. IN NO EVENT SHALL BASTIEN ARACIL BE LIABLE FOR ANY
-    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ *   DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ *   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ *   LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-*/
+ *
+ *   @package FPC_AMFPHP_Plugins_ServiceAccess
+ */
 
 /**
  * User: Bastien Aracil
  * Date: 16/07/11
  */
-
 require_once "Providers/ClassLoader.php";
 
 require_once "IServiceAccessUser.php";

diff --git a/ServiceAccess/ServiceAccess/Providers/CurrentUserLoginSAVoterProvider.php b/ServiceAccess/ServiceAccess/Providers/CurrentUserLoginSAVoterProvider.php
@@ -37,14 +37,15 @@
  * of the {@link FPC_CurrentUserLoginSAVoter}. The syntax is :
  *
  * <code>
- *  @isCurrentUserLogin [index[,loginProperty]]
+ *  /**
+ *   * @isCurrentUserLogin [index[,loginProperty]]
+ *   {@*}
  * </code>
  *
  * @package FPC_AMFPHP_Plugins_ServiceAccess
  * @subpackage provider
  * @author Bastien Aracil
  */
-
 class FPC_CurrentUserLoginSAVoterProvider extends FPC_AbstractReflectionSAVoterProvider implements FPC_IServiceAccessVoterProvider {
 
     const DEFAULT_IS_CURRENT_USER_LOGIN_TAG = "isCurrentUserLogin";

diff --git a/ServiceAccess/ServiceAccess/Providers/Voters/MethodSAVoter.php b/ServiceAccess/ServiceAccess/Providers/Voters/MethodSAVoter.php
@@ -54,6 +54,7 @@
  *   public function checkMethod($serviceName, $methodName, $user, $parameters) {
  *      //do some checking and return true or false
  *  }
+ * </code>
  *
  * the result of the method is returned by this voter.
  * If the $checkMethod does not exists, the access is denied