Property tag allows [optional=default] but not =default format

[mscuthbert]

I'm pretty new to jsdoc3 so I may have missed something, but I love using the

@property {string} name - person's name

format, especially since I'm in an AMD environment where I seem to need @memberof otherwise to document a value. I've noticed though that

@property {string} name="Mary" - person's name

does not work for showing the default value of the property (in cases where there is a static default), but documenting it as an optional @param attribute does work:

@property {string} [name="Mary"] - person's name

This, however, puts a designation in the generated documentation that it is optional (all properties are...). Is there a workaround or is this a bug in the system? (if support for the last one IS a bug, please don't remove it!) Thanks!

[hegemonic]

I agree that we should support name="Mary" (without brackets). That wouldn't make very much sense for the @param tag (if the parameter is required, how can it have a "default value"?), but I can see how this would be very useful for @property.

For now, I don't think there's a good workaround, but I'm pretty sure it'll be easy to implement this feature. If so, I'll take care of it soon.

[hegemonic]

Fixed on master. Tags like @property {string} name="Mary" - person's name should now work as expected.

[iniatse]

This does not work:

@property {object[]} dataSorted=[] some description

It just displays [ within the generated documentation (jsdoc 3.6.3)

[iniatse]

Anybody?

[NielsPichon]

@iniatse Have you found a solution? I have found that ] and spaces always get registered as part of the description, not the default value.