amekusa / docolatte Goto Github PK

I didn't know where to leave this comment, so sorry if this is not the best place, but I wanted to thank you for this project. It has been so hard to find a theme for JSDoc! You have no idea! Yours it's just perfect 👌

First of all: I love this template. One of the best!

There is a bug in TempUtil - you set the length of the items array instead of using a comparison operator! So the method will only render the first item...

Hi,
Excellent theme, thank you.

I'm not sure if this is a you issue or a jsdoc issue, but got to start somewhere.

According to this issue here: jsdoc/jsdoc#1283
JSDoc has an undocumented @modifies tag. The linked commit: jsdoc/jsdoc@2f99af8 suggests that you use it just like the @param tag.

However when I use it like that it doesn't render out properly.

If I use the style suggested on the linked issue:

/**
  * @modifies {unread} The unread count is updated
  */
  async function_name() {...}

It renders like this:

If I use the standard @param style, like this:

/**
  * @modifies {Number} unread The unread count is updated
  */
  async function_name() {...}

It renders like this:

If I use this format:

/**
  * @modifies The unread count is updated
  */
  async function_name() {...}

It renders this:

Running
jsdoc -X .... produces this output (on this style: @modifies {Number} unread The unread count is updated):

"params": [
            {
                "type": {
                    "names": [
                        "String"
                    ]
                },
                "description": "<p>The id of the notification to mark as read</p>",
                "name": "id"
            }
        ],
"modifies": [
            {
                "type": {
                    "names": [
                        "Number"
                    ]
                },
                "description": "<p>unread The unread count is updated</p>"
            }
        ],
"returns": [
            {
                "type": {
                    "names": [
                        "Boolean"
                    ]
                },
                "description": "<p>true if the database was updated successfully</p>"
            }
        ],

From this I gather that the reason the name 'unread' doesn't appear is because either the jsdoc parser itself (or the markdown plugin) isn't creating a 'name' key. But there is a description, so why does that not end up in the rendered output?

I've looked at as many JSDoc templates as I could find and yours is easily my favorite!
I installed it but got the high severity vulnerability message in npm so I had to uninstall since security is a big deal around here.
I guess JSDoc has moved on from using TaffyDB? If you could update the template I would happily use it and highly recommend it to all my coworkers.

Thanks for all the work!