You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We should update the Getting Started page to explain how, and why, we merge adjacent comment blocks. In brief, it's to help users document overloaded methods.
Here's the intended use case:
/** * Get the foo. *//** * Set the foo. * @param {string} newFoo - The new foo. */functionfoo(newFoo){if(newFoo===undefined){returnfoo;}foo=newFoo;}
The docs may cover overloaded methods elsewhere (I haven't checked), but since the Getting Started page talks about JSDoc comment syntax, we should mention this behavior there.
The text was updated successfully, but these errors were encountered:
We should update the Getting Started page to explain how, and why, we merge adjacent comment blocks. In brief, it's to help users document overloaded methods.
Here's the intended use case:
The docs may cover overloaded methods elsewhere (I haven't checked), but since the Getting Started page talks about JSDoc comment syntax, we should mention this behavior there.
The text was updated successfully, but these errors were encountered: