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

TypeDoc adds docblock @propery tags as properties #26

Closed
wants to merge 1 commit into from

Conversation

urmaul
Copy link

@urmaul urmaul commented Oct 26, 2015

Basic implementation for #7

@cebe
Copy link
Member

cebe commented Oct 28, 2015

thanks for adding this. it may cause problems with properties added via getters and setters in the framework, need to check that before merge.

@cebe cebe self-assigned this Oct 28, 2015
@cebe cebe added the type:enhancement Enhancement label Oct 28, 2015
@cebe cebe added this to the 2.0.5 milestone Oct 28, 2015
@urmaul
Copy link
Author

urmaul commented Oct 29, 2015

I see. It will add an error Property $propertyName conflicts with a defined getter {$method->name} in {$class->name}..
https://github.com/yiisoft/yii2-apidoc/blob/master/models/Context.php#L312

@urmaul urmaul closed this Oct 29, 2015
@cebe
Copy link
Member

cebe commented Oct 29, 2015

yeah but it is still a good idea to add it. just need to avoid the conflict.

@cebe cebe reopened this Oct 29, 2015
@cebe cebe modified the milestones: 2.0.6, 2.0.5 Mar 17, 2016
@cebe
Copy link
Member

cebe commented Nov 22, 2016

Lets close this for now. The framework auto generates the @property docs, this would duplicate the documentation for each magic property. Thanks for the contribution anyway!

@cebe cebe closed this Nov 22, 2016
@cebe cebe removed this from the 2.0.6 milestone Nov 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:enhancement Enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants