magic @property before class declaration

[aleksanderd]

Hi!

I just noticed a @Property which described before a class declarations do not rendered to result apidoc htmls :(

For example, even AR-model classes genereated by gii have such @Property comments for each db field, but they do not appers in the docs.

Other case is for AR-relations. If a model have a relation to (for ex) User model, there is a method like:

/**
     * @return \yii\db\ActiveQuery
     */
    public function getUser()
    {
        return $this->hasOne(User::className(), ['id' => 'user_id']);
    }

While the method $model->getUser() returns ActiveQuery, the magic property $model->user will return User class instance (see why). I think, it is enough reason to describe the method and property separately.

It is possible to put magic @Property comments/descriptions to the result docs indepenently from the getter/setter method?

Thank you!

[brandonkelly]

Ditto for @method! And probably goes without saying, but any [[Class::property]] / [[Class::method()]] cross links should also be able to resolve to doc block-defined @property / @methods too.

[brandonkelly]

Maybe also worth mentioning that there are cases where Yii’s own doc blocks are expecting this feature to exist. For example the [[scenario]] link in yii\base\Model::validate().