Automatically keep docs aligned about sublime-jsdocs HOT 7 OPEN

For the first point, is that similar to issue #7? Press tab to align multi-line tag descriptions. Or, do you mean that when you enter in the variable type, the corresponding tags in nearby lines should readjust their spacing?

For the second point, perhaps a config variable to indicate the minimum space between the tag, type, and description?

from sublime-jsdocs.

nah, i think this is separate to #7. What I meant was the following behaviour:

/**
 * @param {type}   foo Description description description description
 * @param {type}   foo Description description description description
 */

now I edit the first parameter's type..

/**
 * @param {number}   foo Description description description description
 * @param {type}   foo Description description description description
 */

boo, out of alignment! How cool would it be if I got this instead:

/**
 * @param {number}   foo Description description description description
 * @param {type}     foo Description description description description
 */

what would be best is if no matter what you typed on each line (and no matter whether you were editing the name, type or description), the columns would adjust to keep everything in line. Bonus points if it can work for blocks you've already declared instead of just as you make them.

from sublime-jsdocs.

Yeah, ok I reckon I could figure something out here. For starters, I might try making it a manual command that you have to run yourself, then maybe add a config setting to enable 'realtime' alignment or some such. Sound good?

from sublime-jsdocs.

There is an issue with mixed tags, and how their "content" is supposed to align.

/**
 * @param  {Number} fooBarVar Description description description description
 * @return {String}           description description
 */

or

/**
 * @param  {Number} fooBarVar Description description description description
 * @return {String} description description
 */

from sublime-jsdocs.

Hmm. I think my preference is usually the latter, but i guess it depends
on how you've implemented it as to which is easier to do. I don't think
it really makes much difference to the readability of the thing and I
don't think i'd mind either way, but I generally choose to leave no
space to maximise the line length of the return description.

to include wrapping in the aforementioned blocks:

/**

• @param {Number} fooBarVar Description description description

•                        description description
  

• @return {String} description description description

•              description description
  

  */

On 9/12/2011 12:03 AM, Nick Fisher wrote:

There is an issue with mixed tags, and how their "content" is supposed to align.

/**
  * @param  {Number} fooBarVar Description description description description
  * @return {String}           description description
  */

or

/**
  * @param  {Number} fooBarVar Description description description description
  * @return {String} description description
  */

---

Reply to this email directly or view it on GitHub:
#14 (comment)

---

No virus found in this message.
Checked by AVG - www.avg.com
Version: 2012.0.1873 / Virus Database: 2102/4673 - Release Date: 12/10/11

from sublime-jsdocs.

Looks like this issue is almost a year old now. I would just like to reiterate that I agree, and I think it would be awesome if this were implemented. Ideally it should be automatic, when one is editing, but it would still be ok, if I had to invoke it manually via key combination.

from sublime-jsdocs.

Pull requests welcome 😄

from sublime-jsdocs.