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

JSDoc wrapping long strings not working. Possible to concatenate or have a special format for it to concatenate #31996

Closed
lunchboxsushi opened this issue Aug 3, 2017 · 1 comment
Assignees
Labels
*duplicate Issue identified as a duplicate of another issue(s) javascript JavaScript support issues

Comments

@lunchboxsushi
Copy link

  • VSCode Version: 1.13.1
  • OS Version: Windows 10 (64-bit)

Steps to Reproduce:

/**
 * GrafConfig is the configuration class that is to be injected into the Graf class
 *      it does not do anything special!
 * 
 * @class GrafConfig
 * @param {Point []} points the (x,y) array of positions for the current graph
 * @param {string} xDescription the title for the x axis to be displayed
 * @param {string} yDescription the title for the y axis to be displayed
 * @param {string} title the title for the graph that will be displayed at the top
 * @param { }
 */
let GrafConfig = function (points, xDescription, yDescription, title) {}

/* this line here you can press ctrl+. after new GrafConfig */
var grafConf = new GrafConfig(graphBucket, "Years old", "daily Income", "age vs income chart");
  1. you can copy my code from above to start, simply use the function and on the definition press ctrl+. two times to get the JSDoc information

    vscode jsdoc bug

my question is, if you get a really really long description can we get the wrapping to work nicer? currently it will just break it off in the middle rather then expanding out and wrap in horrible places. if you view my image where the red line is, it should concat

I think I've seen similar issues open but I haven't seen this exact problem open yet.

Reproduces without extensions: Yes/No

@vscodebot vscodebot bot assigned mjbvz Aug 3, 2017
@vscodebot vscodebot bot added the javascript JavaScript support issues label Aug 3, 2017
@mjbvz mjbvz added the *duplicate Issue identified as a duplicate of another issue(s) label Aug 3, 2017
@mjbvz
Copy link
Collaborator

mjbvz commented Aug 3, 2017

This is a duplicate of #11877

We currently display suggestion documentation as plaintext. #11877 tracks support for displaying markdown documentation content which would fix this issue

@mjbvz mjbvz closed this as completed Aug 3, 2017
@vscodebot vscodebot bot locked and limited conversation to collaborators Nov 17, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
*duplicate Issue identified as a duplicate of another issue(s) javascript JavaScript support issues
Projects
None yet
Development

No branches or pull requests

2 participants