@sebastianwessel/esdoc/out/src/Doc/ExternalDoc.js

Fork of ESDoc - A Good Documentation Generator For JavaScript

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = void 0;

var _colorLogger = _interopRequireDefault(require("color-logger"));

var _AbstractDoc = _interopRequireDefault(require("./AbstractDoc.js"));

var _ParamParser = _interopRequireDefault(require("../Parser/ParamParser.js"));

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

/**
 * Doc Class from virtual comment node of external.
 */
class ExternalDoc extends _AbstractDoc.default {
  /**
   * apply own tag.
   * @private
   */
  _apply() {
    super._apply();

    Reflect.deleteProperty(this._value, 'export');
    Reflect.deleteProperty(this._value, 'importPath');
    Reflect.deleteProperty(this._value, 'importStyle');
  }
  /** specify ``external`` to kind. */


  _$kind() {
    super._$kind();

    this._value.kind = 'external';
  }
  /** take out self name from tag */


  _$name() {
    const value = this._findTagValue(['@external']);

    if (!value) {
      _colorLogger.default.w('can not resolve name.');
    }

    this._value.name = value;

    const tags = this._findAll(['@external']);

    if (!tags) {
      _colorLogger.default.w('can not resolve name.');

      return;
    }

    let name;

    for (const tag of tags) {
      const {
        typeText,
        paramDesc
      } = _ParamParser.default.parseParamValue(tag.tagValue, true, false, true);

      name = typeText;
      this._value.externalLink = paramDesc;
    }

    this._value.name = name;
  }
  /** take out self memberof from file path. */


  _$memberof() {
    super._$memberof();

    this._value.memberof = this._pathResolver.filePath;
  }
  /** specify name to longname */


  _$longname() {
    super._$longname();

    if (this._value.longname) return;
    this._value.longname = this._value.name;
  }
  /** avoid unknown tag */


  _$external() {}

}

exports.default = ExternalDoc;