Skip to content

Custom tag not working #31

@Ridermansb

Description

@Ridermansb

I create an new tag ..

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

Inclide in my jsdoc.json ..

{
  "tags": {
    "allowUnknownTags": true,
    "dictionaries": ["jsdoc"]
  },
  "source": {
    "include": ["package.json", "README.md"],
    "includePattern": ".js$",
    "excludePattern": "(node_modules/|docs)"
  },
  "plugins": [
    "plugins/markdown",
    "./jsdoc/topic.js" // HERE
  ],
  "opts": {
    "template": "./node_modules/minami",
    "encoding": "utf8",
    "destination": "docs/",
    "recurse": true,
    "verbose": true
  },
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": true,
    "useLongnameInNav": false,
    "showInheritedInNav": true
  }
}

Added into my code

  • @topic to/robot/{MAC_ADDRESS}

But nothing change in doc

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions