Tabnine Logo For Javascript
parse
Code IndexAdd Tabnine to your IDE (free)

How to use
parse
function
in
doctrine

Best JavaScript code snippets using doctrine.parse(Showing top 3 results out of 315)

origin: LindenHolt-Whittaker/styleguidist-bug-reproduction

doc.methods.map(method => {
    return Object.assign(method, {
      tags: getDoctrineTags(doctrine.parse(method.docblock)),
    });
  })
origin: LindenHolt-Whittaker/styleguidist-bug-reproduction

// Read doclets of props
    Object.keys(doc.props).forEach(propName => {
      const prop = doc.props[propName];
      const doclets = getDocletsObject(prop.description);
      // when a prop is listed in defaultProps but not in props the prop.description is undefined
      const documentation = doctrine.parse(prop.description || '');

      // documentation.description is the description without tags
      doc.props[propName].description = documentation.description;
      doc.props[propName].tags = getDoctrineTags(documentation);

      // Remove ignored props
      if (doclets && doclets.ignore) {
        delete doc.props[propName];
      }
    });
origin: nodejs/http2

jsdoc = doctrine.parse(jsdocNode.value, {
  strict: true,
  unwrap: true,
doctrine(npm)parse

JSDoc

Parse the given content as a jsdoc comment.

Most used doctrine functions

  • 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'.
  • Tag.type
    The type of the thing this tag is documenting.

Popular in JavaScript

  • superagent
    elegant & feature rich browser / node HTTP with a fluent API
  • node-fetch
    A light-weight module that brings window.fetch to node.js
  • minimist
    parse argument options
  • winston
    A logger for just about everything.
  • http
  • colors
    get colors in your node.js console
  • ws
    Simple to use, blazing fast and thoroughly tested websocket client and server for Node.js
  • readable-stream
    Streams3, a user-land copy of the stream library from Node.js
  • mime-types
    The ultimate javascript content-type utility.
  • Top Sublime Text plugins
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