Tabnine Logo For Javascript
Tag.description
Code IndexAdd Tabnine to your IDE (free)

How to use
description
function
in
Tag

Best JavaScript code snippets using doctrine.Tag.description(Showing top 1 results out of 315)

origin: nodejs/http2

    if (!tag.description && requireParamDescription) {
      context.report({ node: jsdocNode, message: "Missing JSDoc parameter description for '{{name}}'.", data: { name: tag.name } });
      if (!isValidReturnType(tag) && !tag.description && requireReturnDescription) {
        context.report({ node: jsdocNode, message: "Missing JSDoc return description." });
const regex = new RegExp(options.matchDescription);
if (!regex.test(jsdoc.description)) {
  context.report({ node: jsdocNode, message: "JSDoc description does not satisfy the regex pattern." });
doctrine(npm)Tagdescription

JSDoc

The description of the thing this tag is documenting.

Most used doctrine functions

  • parse
    Parse the given content as a jsdoc comment.
  • Annotation.description
    The overall description of the thing being documented.
  • Tag.description
    The description of the thing this tag is documenting.
  • Tag.name
    The name of the thing this tag is documenting, if any.
  • Tag.title
    The title of the jsdoc tag. e.g. `@foo` will have a title of 'foo'.

Popular in JavaScript

  • commander
    the complete solution for node.js command-line programs
  • crypto
  • mocha
    simple, flexible, fun test framework
  • mongodb
    The official MongoDB driver for Node.js
  • rimraf
    A deep deletion module for node (like `rm -rf`)
  • cheerio
    Tiny, fast, and elegant implementation of core jQuery designed specifically for the server
  • moment
    Parse, validate, manipulate, and display dates
  • fs
  • ms
    Tiny millisecond conversion utility
  • Github Copilot alternatives
Tabnine Logo
  • Products

    Search for Java codeSearch for JavaScript code
  • IDE Plugins

    IntelliJ IDEAWebStormVisual StudioAndroid StudioEclipseVisual Studio CodePyCharmSublime TextPhpStormVimGoLandRubyMineEmacsJupyter NotebookJupyter LabRiderDataGripAppCode
  • Company

    About UsContact UsCareers
  • Resources

    FAQBlogTabnine AcademyTerms of usePrivacy policyJavascript Code Index
Get Tabnine for your IDE now