add PHPDoc

Author: Florian Semm

DependencyInjection/Compiler/AddCreateDocumentCommandPass.php

@@ -7,8 +7,8 @@
 
 class AddCreateDocumentCommandPass implements CompilerPassInterface
 {
-    /* (non-PHPdoc)
-     * @see Symfony\Component\DependencyInjection\Compiler.CompilerPassInterface::process()
+    /**
+     * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)
     {

DependencyInjection/Configuration.php

@@ -9,8 +9,7 @@ class Configuration implements ConfigurationInterface
 {
 
     /**
-     * (non-PHPdoc)
-     * @see \Symfony\Component\Config\Definition\ConfigurationInterface::getConfigTreeBuilder()
+     * @return TreeBuilder
      */
     public function getConfigTreeBuilder()
     {

DependencyInjection/FSSolrExtension.php

@@ -10,17 +10,12 @@
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\DependencyInjection\Loader;
 
-/**
- * This is the class that loads and manages your bundle configuration
- *
- * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
- */
 class FSSolrExtension extends Extension
 {
 
     /**
-     * (non-PHPdoc)
-     * @see \Symfony\Component\DependencyInjection\Extension\ExtensionInterface::load()
+     * @param array $configs
+     * @param ContainerBuilder $container
      */
     public function load(array $configs, ContainerBuilder $container)
     {

Event/Listener/DeleteLogListener.php

@@ -7,8 +7,7 @@ class DeleteLogListener extends AbstractLogListener
 {
 
     /**
-     * (non-PHPdoc)
-     * @see \FS\SolrBundle\Event\EventListenerInterface::notify()
+     * @param Event $event
      */
     public function onSolrDelete(Event $event)
     {

Event/Listener/InsertLogListener.php

@@ -7,8 +7,7 @@ class InsertLogListener extends AbstractLogListener
 {
 
     /**
-     * (non-PHPdoc)
-     * @see \FS\SolrBundle\Event\EventListenerInterface::notify()
+     * @param Event $event
      */
     public function onSolrInsert(Event $event)
     {

Event/Listener/UpdateLogListener.php

@@ -7,8 +7,7 @@ class UpdateLogListener extends AbstractLogListener
 {
 
     /**
-     * (non-PHPdoc)
-     * @see \FS\SolrBundle\Event\EventListenerInterface::notify()
+     * @param Event $event
      */
     public function onSolrUpdate(Event $event)
     {

Repository/Repository.php

@@ -29,8 +29,9 @@ public function __construct(Solr $solr, $entity)
         $this->entity = $entity;
     }
 
-    /* (non-PHPdoc)
-     * @see FS\SolrBundle\Repository.RepositoryInterface::find()
+    /**
+     * @param int $id
+     * @return object|null
      */
     public function find($id)
     {
@@ -54,8 +55,8 @@ public function find($id)
         return array_pop($found);
     }
 
-    /* (non-PHPdoc)
-     * @see FS\SolrBundle\Repository.RepositoryInterface::findAll()
+    /**
+     * @return array of found documents
      */
     public function findAll()
     {
@@ -78,8 +79,9 @@ public function findAll()
         return $this->solr->query($query);
     }
 
-    /* (non-PHPdoc)
-     * @see FS\SolrBundle\Repository.RepositoryInterface::findBy()
+    /**
+     * @param array $args
+     * @return array of found documents
      */
     public function findBy(array $args)
     {
@@ -92,8 +94,9 @@ public function findBy(array $args)
         return $this->solr->query($query);
     }
 
-    /* (non-PHPdoc)
-     * @see FS\SolrBundle\Repository.RepositoryInterface::findOneBy()
+    /**
+     * @param array $args
+     * @return array
      */
     public function findOneBy(array $args)
     {

Solr.php

@@ -218,7 +218,7 @@ private function addToIndex(MetaInformation $metaInformation, $entity)
 
     /**
      * @param AbstractQuery $query
-     * @return array found entities
+     * @return array of found documents
      */
     public function query(AbstractQuery $query)
     {