Как добавить и использовать тег в jsdoc?

Я пытаюсь добавить customTag в jsdoc. Я создал файл в каталоге плагинов следующим образом:

метод.js

exports.defineTags = function(dictionary) {
    dictionary.defineTag("methodHttp", {
        mustHaveValue: true,
        canHaveType: false,
        canHaveName: true,
        onTagged: function(doclet, tag) {
            doclet.methodHttp = tag.value;
        }
    });
};

Затем я добавил в свой conf.json:

{
    "tags": {
        "allowUnknownTags": true
    },
    "source": {
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": [ "plugins/method" ],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false,
        "default": {
            "outputSourceFiles": true
        }
    },
    "jsVersion": 180
}

И теперь я пытаюсь получить это на своем шаблоне. Я использую метод.tmpl.

Я старался:

self.find('methodHttp')[0]
data.methodHttp[0]
data.methodHttp

Но это не работает. Что не так с моим кодом?


person kavaliero    schedule 20.02.2013    source источник


Ответы (1)


jsDoc.defineTag не поддерживает теги с заглавными буквами...

Хотя, кажется, это ошибка в их словаре!

person bumpmann    schedule 26.02.2013