Merge pull request #990 from Flyingmana/patch-7

add @see annotation before class to make it recognizable by IDE
magento · Jan 22, 2015 · eda19a8 · eda19a8
2 parents 1e45a1e + d646c46
commit eda19a8
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 8 deletions.
diff --git a/...ion/testsuite/Magento/Framework/Code/_expected/SourceClassWithNamespaceFactory.php.sample b/...ion/testsuite/Magento/Framework/Code/_expected/SourceClassWithNamespaceFactory.php.sample
@@ -2,7 +2,7 @@
 namespace Magento\Framework\Code\GeneratorTest;
 
 /**
- * Factory class for Magento\Framework\Code\GeneratorTest\SourceClassWithNamespace
+ * Factory class for @see \Magento\Framework\Code\GeneratorTest\SourceClassWithNamespace
  *
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.

diff --git a/...ation/testsuite/Magento/Framework/Code/_expected/SourceClassWithNamespaceProxy.php.sample b/...ation/testsuite/Magento/Framework/Code/_expected/SourceClassWithNamespaceProxy.php.sample
@@ -2,7 +2,7 @@
 namespace Magento\Framework\Code\GeneratorTest\SourceClassWithNamespace;
 
 /**
- * Proxy class for Magento\Framework\Code\GeneratorTest\SourceClassWithNamespace
+ * Proxy class for @see \Magento\Framework\Code\GeneratorTest\SourceClassWithNamespace
  *
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.

diff --git a/dev/tests/unit/testsuite/Magento/Framework/Api/Code/Generator/_files/SampleBuilder.txt b/dev/tests/unit/testsuite/Magento/Framework/Api/Code/Generator/_files/SampleBuilder.txt
@@ -1,7 +1,7 @@
 namespace \Magento\Framework\Api\Code\Generator;
 
 /**
- * Builder class for \Magento\Framework\Api\Code\Generator\Sample
+ * Builder class for @see \Magento\Framework\Api\Code\Generator\Sample
  */
 class SampleBuilder extends \Magento\Framework\Api\ExtensibleObjectBuilder
 {

diff --git a/dev/tests/unit/testsuite/Magento/Framework/Api/Code/Generator/_files/SampleMapper.txt b/dev/tests/unit/testsuite/Magento/Framework/Api/Code/Generator/_files/SampleMapper.txt
@@ -1,7 +1,7 @@
 namespace \Magento\Framework\Api\Code\Generator;
 
 /**
- * Mapper class for \Magento\Framework\Api\Code\Generator\Sample
+ * Mapper class for @see \Magento\Framework\Api\Code\Generator\Sample
  */
 class SampleMapper
 {

diff --git a/...unit/testsuite/Magento/Framework/Api/Code/Generator/_files/SampleSearchResultsBuilder.txt b/...unit/testsuite/Magento/Framework/Api/Code/Generator/_files/SampleSearchResultsBuilder.txt
@@ -1,7 +1,7 @@
 namespace \Magento\Framework\Api\Code\Generator;
 
 /**
- * SearchResultsBuilder class for \Magento\Framework\Api\Code\Generator\Sample
+ * SearchResultsBuilder class for @see \Magento\Framework\Api\Code\Generator\Sample
  */
 class SampleSearchResultsBuilder extends \Magento\Framework\Api\AbstractSearchResultsBuilder
 {

diff --git a/...ts/unit/testsuite/Magento/Framework/ObjectManager/Code/Generator/_files/SampleFactory.txt b/...ts/unit/testsuite/Magento/Framework/ObjectManager/Code/Generator/_files/SampleFactory.txt
@@ -1,7 +1,7 @@
 namespace \Magento\Framework\ObjectManager\Code\Generator;
 
 /**
- * Factory class for \Magento\Framework\ObjectManager\Code\Generator\Sample
+ * Factory class for @see \Magento\Framework\ObjectManager\Code\Generator\Sample
  */
 class SampleFactory
 {

diff --git a/...ests/unit/testsuite/Magento/Framework/ObjectManager/Code/Generator/_files/SampleProxy.txt b/...ests/unit/testsuite/Magento/Framework/ObjectManager/Code/Generator/_files/SampleProxy.txt
@@ -1,7 +1,7 @@
 namespace \Magento\Framework\ObjectManager\Code\Generator;
 
 /**
- * Proxy class for \Magento\Framework\ObjectManager\Code\Generator\Sample
+ * Proxy class for @see \Magento\Framework\ObjectManager\Code\Generator\Sample
  */
 class Sample_Proxy extends \Magento\Framework\ObjectManager\Code\Generator\Sample
 {

diff --git a/lib/internal/Magento/Framework/Code/Generator/EntityAbstract.php b/lib/internal/Magento/Framework/Code/Generator/EntityAbstract.php
@@ -291,7 +291,7 @@ protected function _validateData()
      */
     protected function _getClassDocBlock()
     {
-        $description = ucfirst(static::ENTITY_TYPE) . ' class for \\' . $this->_getSourceClassName();
+        $description = ucfirst(static::ENTITY_TYPE) . ' class for @see \\' . $this->_getSourceClassName();
         return ['shortDescription' => $description];
     }