Undocumented tag @modifies does not render correctly. about docolatte HOT 7 CLOSED

Hi :) Thank you for reporting the issue.
I tested the following code with the JSDoc's default theme to see if @modifies tag is rendered correctly.

/**
 * Test Class
 */
class TestClass {
	/**
	 * Test Function
	 * @modifies {unread} The unread count is updated
	 */
	async function_name() {}
}

Because the base logic in Docolatte's HTML generation (data parsing, templating, etc.) is mostly derived from the JSDoc's default theme, if there is a bug in the default theme, Docolatte might also have the same issue.

And this is the result (default theme):

So, I see the same issue in the default theme (missing description).

I guess, maybe this is a templating problem. Let me see if I can fix this.

from docolatte.

So, I fixed the template so it can show description of @modifies tag.
This is the rendering result:

This is the code:

/**
 * Test Class
 */
class TestClass {

	/**
	 * Test Function with type and description
	 * @modifies {unread} The unread count is updated
	 */
	async function_name1() {}

	/**
	 * Test Function with type only
	 * @modifies {Number}
	 */
	async function_name2() {}

	/**
	 * Test Function with description only
	 * @modifies The unread count is updated
	 */
	async function_name3() {}

	/**
	 * Test Function with multiple types
	 * @modifies {unread|Number} The unread count is updated
	 */
	async function_name4() {}
}

You can test the fix I just pushed on dev branch. Maybe just copy & paste from the commit log above is faster.

from docolatte.

@albadedan If you are good with the fix, I merge it into master and publish it to npm.

from docolatte.

from docolatte.

Just published v4.5.1 with the fix.
I'm also working on more improvements like foldable menu items.
Thank you for your positive feedback, which motivates me a lot!

from docolatte.

Just tried this and it all works perfectly, thank you.

Foldable menu items does sound good, I do have a few very large tables and things.
Would be good if there was a global setting to default foldable items to open or closed, but then also override at the comment level for a specific item. Not critical by any means, but would be nice.

Also, unrelated, docolatte is the only theme I've found that worked perfectly with jsdoc-vuejs out of the box. All the other themes I tried seemed to require tedious setup, or had dependency issues.

from docolatte.

hmm, I've never tried jsdoc-vuejs but, maybe the reason docolatte works well with it is, I try not to change the code derived from JSDoc's default theme as much as I can, so it works exact same as the default theme at a basic level.

About foldable menu items that I'm trying to implement, yes, it should be able to specify the default (or completely turn off) with option.
Not sure if it would/should be able to override at the comment level, since it is purely presentational feature.
But maybe, would be nice if we also can specify which items are/aren't folded with option.

But anyway, I appreciate your feed back!

from docolatte.