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

Mark model attributes using @attribute instead of @property #26

Closed
Reinmar opened this issue Sep 3, 2015 · 4 comments
Closed

Mark model attributes using @attribute instead of @property #26

Reinmar opened this issue Sep 3, 2015 · 4 comments
Labels
resolution:invalid This issue is invalid (e.g. reports a non-existent bug or a by-design behavior).

Comments

@Reinmar
Copy link
Member

Reinmar commented Sep 3, 2015

Currently we use one tag for all of them what requires reading the code to understand their meaning. Let's introduce an @Attribute tag and we'll find a way to extend JSDoc to handle it.

@jodator
Copy link
Contributor

jodator commented Sep 4, 2015

What's the difference between @attribute and @property?

Also I don't recall any doc lib using @attribute (jsdoc, Google Closure compiler - actually google extends this) - so I guess that @attribute is a special @property, am I right?

@Reinmar
Copy link
Member Author

Reinmar commented Sep 4, 2015

The difference is that attribute is part of a model's state, while property isn't. At least, if I remember the intention correctly.

I also don't recall any library using attributes, but they definitely do extend JSDoc. Actually, just like you extended JSDuck :).

@jodator
Copy link
Contributor

jodator commented Sep 4, 2015

I don't get the difference but I didn't dig into Models definition either so I guess it is valid case.

@Reinmar
Copy link
Member Author

Reinmar commented Mar 10, 2016

I opened a new issue for this, because that doesn't make sense any more to make some big differentiation between attrs and props: #107

@Reinmar Reinmar closed this as completed Mar 10, 2016
oleq added a commit that referenced this issue Jul 4, 2016
oleq added a commit that referenced this issue Jul 4, 2016
@Reinmar Reinmar added the resolution:invalid This issue is invalid (e.g. reports a non-existent bug or a by-design behavior). label Nov 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
resolution:invalid This issue is invalid (e.g. reports a non-existent bug or a by-design behavior).
Projects
None yet
Development

No branches or pull requests

2 participants