How to break long docblock method declarations
I'm trying to improve my code. I've declared several methods in the docblock because these are inherited methods but return the class itself instead of it's parent.
<?php
namespace Financial\Table;
/**
* Class Ledger
*
* @package Financial\Table
*
* @method static \Financial\Table\Ledger getInstance(\Zend_Db_Adapter_Abstract $conn = null)
* @method \Financial\Model\Ledger getOne($where = null, $order = [], $limit = null, $offset = null, $columns = null)
* @method \Financial\Model\Ledger get($pkData, $columns = null)
* @method \Financial\Model\Ledger createEntity($data = null, $entityClassName = null)
* @method \Financial\Model\Ledger[]|\Phango\Db\ResultSet getSet($where = null, $order = [], $limit = null, $offset =
* null, $columns = null)
*/
class Ledger extends TableAbstract
{
}
The getSet() method is the issue here. I've configured my codestyle so it breaks automatically. PHPStorm did this now, but the wrapped text is not correctly recognized by PHPStorm, it shows an error and it does not suggest all arguments in the code completion.
Please sign in to leave a comment.
You can't wrap the comment, unfortunately, and the fact that PhpStorm does it is a bug: https://youtrack.jetbrains.com/issue/WI-42771