How to use

description

function

in

Annotation

// 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];
      }
    });