Function getJSDocs

packages/dev/parcel-transformer-docs/DocsTransformer.js:851–914

(path)

    }

    function getJSDocs(path) {
      let comments = getDocComments(path);
      if (comments) {
        let parsed = doctrine.parse(comments, {
          // have doctrine itself remove the comment asterisks from content
          unwrap: true,
          // enable parsing of optional parameters in brackets, JSDoc3 style
          sloppy: true,
          // `recoverable: true` is the only way to get error information out
          recoverable: true
        });

        let result = {
          description: parsed.description
        };

        for (let tag of parsed.tags) {
          if (tag.title === 'default') {
            result.default = tag.description;
          } else if (tag.title === 'access') {
            result.access = tag.description;
          } else if (tag.title === 'private' || tag.title === 'deprecated') {
            result.access = 'private';
          } else if (tag.title === 'protected') {
            result.access = 'protected';
          } else if (tag.title === 'public') {
            result.access = 'public';
          } else if (tag.title === 'return' || tag.title === 'returns') {
            result.return = tag.description;
          } else if (tag.title === 'param') {
            if (!result.params) {
              result.params = {};
            }

            result.params[tag.name] = tag.description;
          } else if (tag.title === 'selector') {
            result.selector = tag.description;
          } else if (tag.title === 'example') {
            if (!result.examples) {
              result.examples = [];
            }

            if (tag.description) {
              result.examples.push(
                tag.description
                  .split('\n')
                  .map(line => line.replace(/^\s{2}/, ''))
                  .join('\n')
              );
            }
          }
        }

        if (result.examples) {
          result.examples = [
            ...new Set(result.examples.map(example => example.trim()).filter(Boolean))
          ];
        }