doctrine / mongodb-odm

lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php

Doc Comments +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
      *      - reflClass (ReflectionClass)
      *      - reflFields (ReflectionProperty array)
      *
-     * @return array The names of all the fields that should be serialized.
+     * @return string[] The names of all the fields that should be serialized.
      */
     public function __sleep()
     {

lib/Doctrine/ODM/MongoDB/Mapping/Driver/YamlDriver.php

Doc Comments +1 added lines

@@ -38,6 +38,7 @@
 
     /**
      * {@inheritDoc}
+     * @param \Doctrine\Common\Persistence\Mapping\Driver\SymfonyFileLocator $locator
      */
     public function __construct($locator, $fileExtension = self::DEFAULT_FILE_EXTENSION)
     {

lib/Doctrine/ODM/MongoDB/Query/CriteriaMerger.php

Doc Comments -1 removed lines

@@ -31,7 +31,6 @@
     /**
      * Combines any number of criteria arrays as clauses of an "$and" query.
      *
-     * @param array $criteria,... Any number of query criteria arrays
      * @return array
      */
     public function merge(/* array($field => $value), ... */)

lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadataInfo.php

Doc Comments +1 added lines, -1 removed lines

@@ -841,7 +841,7 @@
     /**
      * Gets the ReflectionProperties of the mapped class.
      *
-     * @return array An array of ReflectionProperty instances.
+     * @return \ReflectionProperty[] An array of ReflectionProperty instances.
      */
     public function getReflectionProperties()
     {

lib/Doctrine/ODM/MongoDB/CommandCursor.php

Doc Comments +1 added lines, -1 removed lines

@@ -159,7 +159,7 @@
      *
      * @see http://php.net/manual/en/iterator.key.php
      * @see http://php.net/manual/en/mongocommandcursor.key.php
-     * @return integer
+     * @return string
      */
     public function key()
     {

lib/Doctrine/ODM/MongoDB/PersistentCollection/DefaultPersistentCollectionGenerator.php

Doc Comments +5 added lines

@@ -84,6 +84,11 @@
         return $className;
     }
 
+    /**
+     * @param string $for
+     * @param string $targetFqcn
+     * @param string|false $fileName
+     */
     private function generateCollectionClass($for, $targetFqcn, $fileName)
     {
         $exploded = explode('\\', $targetFqcn);

lib/Doctrine/ODM/MongoDB/Tools/DocumentGenerator.php

Doc Comments +13 added lines

@@ -771,6 +771,10 @@ 
         return implode("\n", $lines);
     }
 
+    /**
+     * @param string $type
+     * @param string $defaultValue
+     */
     private function generateDocumentStubMethod(ClassMetadataInfo $metadata, $type, $fieldName, $typeHint = null, $defaultValue = null)
     {
         // Add/remove methods should use the singular form of the field name
@@ -955,6 +959,9 @@ 
         return implode("\n", $lines);
     }
 
+    /**
+     * @param integer $type
+     */
     private function getInheritanceTypeString($type)
     {
         switch ($type) {
@@ -972,6 +979,9 @@ 
         }
     }
 
+    /**
+     * @param integer $policy
+     */
     private function getChangeTrackingPolicyString($policy)
     {
         switch ($policy) {
@@ -989,6 +999,9 @@ 
         }
     }
 
+    /**
+     * @param string $type
+     */
     private function getIdGeneratorTypeString($type)
     {
         switch ($type) {

lib/Doctrine/ODM/MongoDB/SchemaManager.php

Doc Comments +2 added lines, -2 removed lines

@@ -582,9 +582,9 @@
     }
 
     /**
-     * @param $documentName
+     * @param string $documentName
      *
-     * @return array
+     * @return string
      */
     private function runShardCollectionCommand($documentName)
     {

lib/Doctrine/ODM/MongoDB/Mapping/Driver/XmlDriver.php

Doc Comments +7 added lines

@@ -36,6 +36,7 @@ 
 
     /**
      * {@inheritDoc}
+     * @param \Doctrine\Common\Persistence\Mapping\Driver\SymfonyFileLocator $locator
      */
     public function __construct($locator, $fileExtension = self::DEFAULT_FILE_EXTENSION)
     {
@@ -241,6 +242,9 @@ 
         $class->addIndex($keys, $options);
     }
 
+    /**
+     * @param string $type
+     */
     private function addEmbedMapping(ClassMetadataInfo $class, $embed, $type)
     {
         $attributes = $embed->attributes();
@@ -278,6 +282,9 @@ 
         $this->addFieldMapping($class, $mapping);
     }
 
+    /**
+     * @param string $type
+     */
     private function addReferenceMapping(ClassMetadataInfo $class, $reference, $type)
     {
         $cascade = array_keys((array) $reference->cascade);