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

Rework comment indentation to support non-JSDoc styles #505

Open
5 tasks done
pzuraq opened this issue Mar 6, 2018 · 1 comment · May be fixed by #506
Open
5 tasks done

Rework comment indentation to support non-JSDoc styles #505

pzuraq opened this issue Mar 6, 2018 · 1 comment · May be fixed by #506

Comments

@pzuraq
Copy link
Contributor

pzuraq commented Mar 6, 2018

Make sure these boxes are checked before submitting your issue - thank you!
(If your issue is neither a both bug nor a request, please write in a free style)

Short summary of your issue

We'd like to support the following comment style:

/**
  A foo class

  ```js
  foo({
    bar: 'baz'
  })
  \```

  @anArbitraryTag
*/

This is much easier to use when typing code examples, but currently all leading space gets stripped due to this line here. A better strategy may be to check for the indentation level of the first non-star character and strip up to that level instead. I can implement this if you agree, just let me know.

@pzuraq pzuraq linked a pull request Mar 6, 2018 that will close this issue
@MattMcFarland
Copy link
Contributor

This project is dead, consider contributing to esdoc2 instead! https://github.com/esdoc2/esdoc2

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

Successfully merging a pull request may close this issue.

2 participants