Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

Add support for namespaced default values #482

Merged
merged 1 commit into from Jan 14, 2017
Merged

Add support for namespaced default values #482

merged 1 commit into from Jan 14, 2017

Conversation

Alhadis
Copy link
Contributor

@Alhadis Alhadis commented Jan 14, 2017

Both of these lines are valid JSDoc constructs:

/**
 * @param {Object} [name=Default.value]
 * @param {Object} [name=defaultValue]
 */

A @param tag's default-value accepts anything that a @type parameter does, so whatever's valid as a @type is also valid as a default value:

/**
 * @type {Default.value}
 * @type {defaultValue}
*/

E.g., @param {Object} [name=Default.value]
@50Wliu 50Wliu merged commit fdf7579 into atom:master Jan 14, 2017
@Alhadis Alhadis deleted the dotfix branch January 14, 2017 20:23
@Alhadis
Copy link
Contributor Author

Alhadis commented Jan 18, 2017

@50Wliu Any thoughts on adding JavaScript highlighting to inline @examples inside JSDoc comments?

It'd be limited to captured regions only, so there's no risk of a begin/end pattern slipping past a terminating */ boundary and ruining the rest of the document's highlighting.

@50Wliu
Copy link
Contributor

50Wliu commented Jan 18, 2017

Sure.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants