Updated comments to conform to our rules and to accomodate the phpCR …

…> PHPCR change from yesterday. The changes are of technical nature, i.e. no significant changes to actual content.

Classes/F3_PHPCR_CredentialsInterface.php

@@ -12,13 +12,18 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN-    *
  * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General      *
  * Public License for more details.                                       *
- *                                                                        */ 
+ *                                                                        */
+
+/**
+ * @package PHPCR
+ * @version $Id$
+ */
 
 /**
  *
- * @package		phpCR
- * @version		$Id$
- * @license		http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
+ * @package PHPCR
+ * @version $Id$
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
 interface F3_PHPCR_CredentialsInterface {}
 

Classes/F3_PHPCR_ItemInterface.php

@@ -14,12 +14,17 @@
  * Public License for more details.                                       *
  *                                                                        */
 
+/**
+ * @package PHPCR
+ * @version $Id$
+ */
+
 /**
  * A Node interface
  *
- * @package		phpCR
- * @version 	$Id$
- * @license		http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
+ * @package PHPCR
+ * @version $Id$
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
 interface F3_PHPCR_ItemInterface {
 
@@ -36,17 +41,17 @@ public function getName();
 
 	/**
 	 * Returns the ancestor of the specified depth.
-	 * 
-	 * An ancestor of depth x is the Item that is x levels down along the path from 
+	 *
+	 * An ancestor of depth x is the Item that is x levels down along the path from
 	 * the root node to this Item.
 	 *
 	 * - depth = 0 returns the root node.
 	 * - depth = 1 returns the child of the root node along the path to this Item.
 	 * - depth = 2 returns the grandchild of the root node along the path to this Item.
 	 * - And so on to depth = n, where n is the depth of this Item, which returns this Item itself.
-	 * 
+	 *
 	 * If depth > n is specified then a ItemNotFoundException is thrown.
-	 * 
+	 *
 	 * @param 	integer		$depth
 	 * @return 	F3_PHPCR_Item	The ancestor of this Item at the specified depth.
 	 * @throws 	F3_PHPCR_ItemNotFoundException if depth < 0 or depth > n where n is the depth of this item.
@@ -57,9 +62,9 @@ public function getAncestor($depth);
 
 	/**
 	 * Returns the depth of this Item in the workspace tree.
-	 * 
+	 *
 	 * Returns the depth below the root node of this Item (counting this Item itself).
-	 * 
+	 *
 	 * - The root node returns 0.
 	 * - A property or child node of the root node returns 1.
 	 * - A property or child node of a child node of the root returns 2.
@@ -79,12 +84,12 @@ public function getDepth();
 	public function getSession();
 
 	/**
-	 * Returns true if this Item object represents the same actual workspace 
+	 * Returns true if this Item object represents the same actual workspace
 	 * item as the object otherItem.
-	 * 
+	 *
 	 * Two Item objects represent the same workspace item if all the following
 	 * are true:
-	 * 
+	 *
 	 * - Both objects were acquired through Session objects that were created
 	 *	 by the same Repository object.
 	 * - Both objects were acquired through Session objects bound to the same
@@ -93,7 +98,7 @@ public function getSession();
 	 *	 objects.
 	 * - If they are Property objects they have identical names and
 	 *	 isSame is true of their parent nodes.
-	 * 
+	 *
 	 * This method does not compare the states of the two items. For example, if two
 	 * Item objects representing the same actual workspace item have been
 	 * retrieved through two different sessions and one has been modified, then this method

Classes/F3_PHPCR_ItemNotFoundException.php

@@ -14,12 +14,17 @@
  * Public License for more details.                                       *
  *                                                                        */
 
+/**
+ * @package PHPCR
+ * @version $Id$
+ */
+
 /**
  * An ItemNotFoundException
  *
- * @package		phpCR
- * @version 	$Id:F3_PHPCR_ItemNotFoundException.php 254 2007-07-09 06:34:07Z robert $
- * @license		http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
+ * @package PHPCR
+ * @version $Id:F3_PHPCR_ItemNotFoundException.php 254 2007-07-09 06:34:07Z robert $
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
 class F3_PHPCR_ItemNotFoundException extends F3_PHPCR_RepositoryException {
 }

Classes/F3_PHPCR_IteratorInterface.php

@@ -14,31 +14,36 @@
  * Public License for more details.                                       *
  *                                                                        */
 
+/**
+ * @package PHPCR
+ * @version $Id$
+ */
+
 /**
  * An Iterator interface
  *
  * The methods next(), hasNext() and remove() as in java.util.Iterator
  * append() is something we though would be nice...
- * 
- * @package		phpCR
- * @version 	$Id$
- * @license		http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
+ *
+ * @package PHPCR
+ * @version $Id$
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
 interface F3_PHPCR_IteratorInterface extends Iterator {
 
 	/**
 	 * Returns the next element. Commented as PHP dows not allow overriding methods from extended interfaces...
-	 * 
+	 *
 	 * @return mixed
 	 * @throws F3_PHPCR_NoSuchElementException if no next element exists
 	 */
 	//public function next();
 
 	/**
 	 * Returns true if the iteration has more elements.
-	 * 
+	 *
 	 * This is an alias of valid().
-	 * 
+	 *
 	 * @return boolean
 	 */
 	public function hasNext();
@@ -48,15 +53,15 @@ public function hasNext();
 	 * This method can be called only once per call to next. The behavior of an iterator
 	 * is unspecified if the underlying collection is modified while the iteration is in
 	 * progress in any way other than by calling this method.
-	 * 
+	 *
 	 * @return void
 	 * @throws IllegalStateException if the next method has not yet been called, or the remove method has already been called after the last call to the next method.
 	 */
 	public function remove();
 
 	/**
 	 * Append a new element to the iteration
-	 * 
+	 *
 	 * @param mixed $element
 	 * @return void
 	 */

Classes/F3_PHPCR_LoginException.php

@@ -14,12 +14,17 @@
  * Public License for more details.                                       *
  *                                                                        */
 
+/**
+ * @package PHPCR
+ * @version $Id$
+ */
+
 /**
  * A LoginException
  *
- * @package		phpCR
- * @version 	$Id:F3_PHPCR_LoginException.php 254 2007-07-09 06:34:07Z robert $
- * @license		http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
+ * @package PHPCR
+ * @version $Id:F3_PHPCR_LoginException.php 254 2007-07-09 06:34:07Z robert $
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
 class F3_PHPCR_LoginException extends F3_PHPCR_RepositoryException {
 }

Classes/F3_PHPCR_NamespaceException.php

@@ -14,12 +14,17 @@
  * Public License for more details.                                       *
  *                                                                        */
 
+/**
+ * @package PHPCR
+ * @version $Id$
+ */
+
 /**
  * A NamespaceException
  *
- * @package		phpCR
- * @version 	$Id$
- * @license		http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
+ * @package PHPCR
+ * @version $Id$
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
 class F3_PHPCR_NamespaceException extends F3_PHPCR_RepositoryException {
 }

Classes/F3_PHPCR_NamespaceRegistryInterface.php

@@ -14,12 +14,17 @@
  * Public License for more details.                                       *
  *                                                                        */
 
+/**
+ * @package PHPCR
+ * @version $Id$
+ */
+
 /**
  * A NamespaceRegistry interface
  *
- * @package		phpCR
- * @version 	$Id$
- * @license		http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
+ * @package PHPCR
+ * @version $Id$
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
 interface F3_PHPCR_NamespaceRegistryInterface {
 

Classes/F3_PHPCR_NoSuchElementException.php

@@ -14,12 +14,17 @@
  * Public License for more details.                                       *
  *                                                                        */
 
+/**
+ * @package PHPCR
+ * @version $Id$
+ */
+
 /**
  * A F3_PHPCR_NoSuchElementException
  *
- * @package		phpCR
- * @version 	$Id$
- * @license		http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
+ * @package PHPCR
+ * @version $Id$
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
 class F3_PHPCR_NoSuchElementException extends F3_PHPCR_RepositoryException {
 }

Classes/F3_PHPCR_NoSuchWorkspaceException.php

@@ -14,12 +14,17 @@
  * Public License for more details.                                       *
  *                                                                        */
 
+/**
+ * @package PHPCR
+ * @version $Id$
+ */
+
 /**
  * A NoSuchWorkspaceException
  *
- * @package		phpCR
- * @version 	$Id:F3_PHPCR_NoSuchWorkspaceException.php 254 2007-07-09 06:34:07Z robert $
- * @license		http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
+ * @package PHPCR
+ * @version $Id:F3_PHPCR_NoSuchWorkspaceException.php 254 2007-07-09 06:34:07Z robert $
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
 class F3_PHPCR_NoSuchWorkspaceException extends F3_PHPCR_RepositoryException {
 }

Classes/F3_PHPCR_NodeInterface.php

@@ -14,12 +14,17 @@
  * Public License for more details.                                       *
  *                                                                        */
 
+/**
+ * @package PHPCR
+ * @version $Id$
+ */
+
 /**
  * A Node interface
  *
- * @package		phpCR
- * @version 	$Id$
- * @license		http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
+ * @package PHPCR
+ * @version $Id$
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
 interface F3_PHPCR_NodeInterface {
 

Classes/F3_PHPCR_NodeIteratorInterface.php

@@ -14,23 +14,28 @@
  * Public License for more details.                                       *
  *                                                                        */
 
+/**
+ * @package PHPCR
+ * @version $Id$
+ */
+
 /**
  * A NodeIterator interface
  *
- * @package		phpCR
- * @version 	$Id$
- * @license		http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
+ * @package PHPCR
+ * @version $Id$
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
 interface F3_PHPCR_NodeIteratorInterface extends F3_PHPCR_RangeIteratorInterface {
 
 	/**
 	 * Returns the next Node in the iteration.
-	 * 
+	 *
 	 * @return F3_PHPCR_NodeInterface
 	 * @throws F3_PHPCR_NoSuchElementException if the iterator contains no more elements.
 	 */
 	public function nextNode();
-	
+
 }
 
 ?>

Classes/F3_PHPCR_NodeTypeDefinitionInterface.php

@@ -14,12 +14,17 @@
  * Public License for more details.                                       *
  *                                                                        */
 
+/**
+ * @package PHPCR
+ * @version $Id$
+ */
+
 /**
  * A NodeType interface
  *
- * @package		phpCR
- * @version 	$Id$
- * @license		http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
+ * @package PHPCR
+ * @version $Id$
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
 interface F3_PHPCR_NodeTypeDefinitionInterface {
 

Classes/F3_PHPCR_NodeTypeInterface.php

@@ -14,12 +14,17 @@
  * Public License for more details.                                       *
  *                                                                        */
 
+/**
+ * @package PHPCR
+ * @version $Id$
+ */
+
 /**
  * A NodeType interface
  *
- * @package		phpCR
- * @version 	$Id$
- * @license		http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
+ * @package PHPCR
+ * @version $Id$
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
 interface F3_PHPCR_NodeTypeInterface extends F3_PHPCR_NodeTypeDefinitionInterface {