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

How to use
Annotation
in
doctrine

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

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];
      }
    });
doctrine(npm)Annotation

JSDoc

Represents a parsed jsdoc comment.

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

  • mkdirp
    Recursively mkdir, like `mkdir -p`
  • path
  • debug
    small debugging utility
  • fs
  • commander
    the complete solution for node.js command-line programs
  • minimist
    parse argument options
  • handlebars
    Handlebars provides the power necessary to let you build semantic templates effectively with no frustration
  • express
    Fast, unopinionated, minimalist web framework
  • lodash
    Lodash modular utilities.
  • Best plugins for Eclipse
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