Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add @see annotation before class to make it recognizable by IDE #990

Merged
merged 1 commit into from
Jan 22, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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
{
Expand Down
Original file line number Diff line number Diff line change
@@ -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
{
Expand Down
Original file line number Diff line number Diff line change
@@ -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
{
Expand Down
Original file line number Diff line number Diff line change
@@ -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
{
Expand Down
Original file line number Diff line number Diff line change
@@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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];
}

Expand Down