@description tag does not works in v3.0.9

halaszbalazs commented 3 years ago

With jsdoc-vuejs v3.0.9 the standard JSDoc @description tag does not rendered into documentation, see my code below:

<script>
/**
 * @description Az értesítési sáv komponense
 * 
 * @vue-computed {Boolean} visible.get - Megvizsgálja, hogy meg kell-e jeleníteni az értesítési sávot
 * @vue-computed {Void} visible.set - Törli az adott response-t
 * @vue-computed {Boolean} hasMessage - Megvizsgálja, hogy van-e message, amit meg lehet jeleníteni
 * @vue-computed {String} html - Visszatér a megjelenítendő üzenettel
 * @vue-computed {String} color - Visszatér a megjelenítendő stílussal
 */
export default {
    name: "toast",
    computed: {
        visible: {
            get: function () {
                return this.hasMessage;
...

I have also tried with @desc tag and single line without @param but does not work. I have found issue #140 which mentioned also the same problem and was fixed back then, but now this is an issue again (at least for me). Is there any way to fix this? For reference I have the following deps in my package.json:

...
"dependencies": {
        "ansi-regex": "^5.0.0",
        "core-js": "^3.6.5",
        "echarts": "^4.9.0",
        "jsdoc": "^3.6.6",
        "jsdoc-vuejs": "^3.0.9",
        "moment": "^2.29.1",
        "strip-ansi": "^6.0.0",
        "tui-jsdoc-template": "^1.2.2",
        "vue": "^2.6.11",
        "vue-echarts-v3": "^2.0.1",
        "vue-i18n": "^8.22.1",
        "vue-moment": "^4.1.0",
        "vue-router": "^3.2.0",
        "vuetify": "^2.2.11",
        "vuex": "^3.4.0",
        "yarn": "^1.22.10"
    },
...

Also my config for .jsdoc.json:

{
    "plugins": [
        "node_modules/jsdoc-vuejs",
        "node_modules/jsdoc/plugins/markdown"
    ],
    "recurseDepth": 10,
    "source": {
        "include": ["src"],
        "includePattern": "\\.(vue|js)$",
        "excludePattern": "(node_modules/|docs)"
    },
    "sourceType": "module",
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc", "closure"]
    },
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": true,
        "logo": {
            "url": "img/xxxx.png",
            "width": "200px",
            "height": "55px",
            "link": "index.html",
            "name": "xxxx",
            "footerText": "xxxx",
            "tabNames": {
                "api": "API",
                "tutorials": "Példakódok"
            }
        },
        "default": {
            "staticFiles": {
                "include": ["./src/assets/documentation/"]
            }
        },
        "css": ["styles/custom.css"]
    },
    "opts": {
        "destination": "./docs/",
        "recurse": true,
        "encoding": "utf8",
        "template": "node_modules/tui-jsdoc-template"
    }
}

Thanks!

Kocal commented 3 years ago

Hi!

That's weird this issue is back again, since there are tests that cover this case.

Also I don't think you have to use any @description or @desc tag, what happens if you use don't use it?

halaszbalazs commented 3 years ago

Hi @Kocal

I have also tried without @description tags (in fact this was my first intention) and the description is not rendered in the docs, after this I have tried with the tags with no luck unfortunately.

I'm using the Tui template with slight CSS modifications which does not affect the description - it's just simply does not show up in the rendered HTML code. I can confirm that all the descriptions work where I don't use the @vue-* params.

halaszbalazs commented 3 years ago

Update: I think I've found the problem. On https://github.com/Kocal/jsdoc-vuejs/blob/master/lib/templates/tui.ejs#L4 there's a style tag which uses display: none; on .container-overview. After removing that, everything works fine, though the container-overview block rendered twice with no content on the second render.

ismatech commented 3 years ago

Hi @Kocal! I still have issue with a description of my props variables. I've checked result html and it's just empty td element. I use better-docs template. But problem isn't connected with it because I checked with default template and it's works less because it doesn't show any props and rest variables. Can you help me with this?

Kocal / jsdoc-vuejs

@description tag does not works in v3.0.9 #394