how document db filed - Githubissues

yiisoft / yii2-apidoc

Yii 2 apidoc extension.

https://www.yiiframework.com

BSD 3-Clause "New" or "Revised" License

258 stars 121 forks source link

how document db filed #191

Closed hooman-mirghasemi closed 4 years ago

hooman-mirghasemi commented 4 years ago

Hi excuse me I have a question when I generate a model extent active record, that model have magic fileds . they are database fileds. how can i write php comment for these filed? apidoc read them and generate document for theme?

hooman-mirghasemi commented 4 years ago

/**

This is the model class for table "tbl_question".
@property string $id
@property string $unique_id
@property string $title */

it seems api doc remove all @property ....

rob006 commented 4 years ago

Is it @Property or @property?

hooman-mirghasemi commented 4 years ago

lower case is correct.

hooman-mirghasemi commented 4 years ago

@samdark can you answer me, please ? how can I write document for database filed such as post model have id, title, content, image .... filed

samdark commented 4 years ago

I don't know, will try it after making next release of Yii 2 and some things on Yii 3.

samdark commented 4 years ago

Verified that it still doesn't work. See #7, #132.

samdark commented 4 years ago

Please test if https://github.com/yiisoft/yii2-apidoc/pull/192 works for you.

hooman-mirghasemi commented 4 years ago

Yes it works. Thank you!