Tag Archives: jsdoc

How to Add and Use New JSDoc Tag Using Plugin?

I am working with JSDoc 3.6.4 to document JavaScript library. I want to mark certain functions available for Pro version so I want to add a new JSDoc tag “@pro” to indicate a certain feature available in Pro version. This requires creating a new JSDoc plugin “protag”. Create a file “protag.js” and place it under […]


How to use JSDoc @event tag correctly?

I am using JSDoc 3.4.2 for my JavaScript API documentation need. By looking at the @event tag example, when I tried to use it, the event name was replaced with “event:” + event name which was a sign that it was looking at the @event tag correctly but found two issues. When I use @fire […]


How to Document Self-executing Anonymous Javascript Function using JSDoc?

I have a class defined in self-executing anonymous Javascript function for which I want to generate the documentation using JSDoc 3.4.2 but I had hard time finding the solution. Solutions searched on the internet did not yield the fruitful result and I had to try various combination of tags in order to get it working. […]


JSDoc Tokenizer plugin to replace the token with values from config

If you are a JavaScript developer, you would have used the JSDoc to document your JavaScript code. I was trying to use the JSDoc for generating the documentation for my PramukhIME Javascript library. I have the core library and based on the plugin, I wanted to generate the documentation to show how the plugin works […]


JSDoc – Customize output documentation files

I am using JSDoc 3.4.2 for my JavaScript library documentation. I wanted to make the change to the output files so here are the tricks I used to make following changes. In order to make the change, I have copied all the files from the default template available at “C:\Users\USERNAME\AppData\Roaming\npm\node_modules\jsdoc\templates\default” (JSDoc over Node.js location) to […]