bvanderlaan / jsdoc-route-plugin

This repository holds a plugin for JsDoc which adds custom tags to the default template for documenting Express routes.
29 stars 9 forks source link

Plugin writing duplicate documentation #8

Open LucAngevare opened 4 years ago

LucAngevare commented 4 years ago

Heya, so I'm having a bit of an issue with jsdoc-route-plugin; this plugin is doing it's job exactly as it should be except for the fact that it's writing the documentation twice. With this I mean that two global functions are being generated, both with the documented changes in this plugin. I have used the exact same configuration as documented; I'd like to know why this occurs and what I can do to fix this. Not using this plugin results in default JSDoc writing the documentation once, which shows that this is not because I have written the documentation correctly where needed. Thanks in advance!

    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc","closure"]
    },
    "source": {
        "include": [ "." ],
        "exclude": [ "node_modules" ],
        "includePattern": ".+\\.js(doc|x)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": ["jsdoc-route-plugin"],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
    },
    "opts": {
      "recurse": true
    }
}
LucAngevare commented 4 years ago

I have also noticed that using this plugin causes there to be no links to areas within the page, so any and all routes written in the documentation will not be linked in any of the navigations (neither in the index.html or global.html files).