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

Prefer single line js docs #764

Closed
dsherret opened this issue Nov 25, 2019 · 0 comments
Closed

Prefer single line js docs #764

dsherret opened this issue Nov 25, 2019 · 0 comments

Comments

@dsherret
Copy link
Owner

dsherret commented Nov 25, 2019

Instead of always doing:

/**
 * Some description.
 */
function myFunc() {
}

It should prefer single line:

/** Some description. */
function myFunc() {
}

Multi-line will occur in either of the two scenarios:

  1. When the js doc text starts with a newline (ex. "\nMy description." -- forces a multi-line js doc)
  2. When the js doc text spans multiple lines.
@dsherret dsherret added this to the Version Next milestone Nov 25, 2019
@dsherret dsherret changed the title Prefer single line jsdocs Prefer single line js docs Nov 25, 2019
dsherret added a commit that referenced this issue Nov 25, 2019
…e().

BREAKING CHANGE: JS docs will be written as a single line unless multi-line or starting with a newline. Additionally, getting a JS doc structure will have a newline at the start if the JS doc description is one line, but the JS doc is multi-line.
@dsherret dsherret modified the milestones: Version Next, Version 6 Nov 30, 2019
@dsherret dsherret reopened this Nov 30, 2019
dsherret added a commit that referenced this issue Dec 1, 2019
BREAKING CHANGE: `JSDoc#setComment(...)` and `#getComment(...)` are now `setDescription(...)` and `getDescription()`. They also work according to #764.
@dsherret dsherret closed this as completed Dec 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant