Home Manual Reference Source Test Repository 
import DocResolver from 'esdoc/src/Publisher/Builder/DocResolver.js'
public class | source

DocResolver

Resolve various properties in doc object.

Test:

Constructor Summary

Public Constructor
public

create instance.

Member Summary

Private Members
private
private

_data: *

Method Summary

Public Methods
public

resolve various properties.
Private Methods
private

resolve access property.
private

resolve duplication identifier.
private

resolve class extends chain.
private

resolve ignore property.
private

resolve @link as html link.
private

resolve description as markdown.
private

resolve necessary identifier.
private

resolve test and identifier relation.
private

resolve undocument identifier doc.
private

resolve unexport identifier doc.

Public Constructors

public constructor(builder: DocBuilder) source

create instance.

Params:

NameTypeAttributeDescription
builder DocBuilder

target doc builder.

Private Members

private _builder: * source

private _data: * source

Public Methods

public resolve() source

resolve various properties.

Private Methods

private _resolveAccess() source

resolve access property. if doc does not have access property, the doc is public. but name is started with '-', the doc is private.

private _resolveDuplication() source

resolve duplication identifier. member doc is possible duplication. other doc is not duplication.

private _resolveExtendsChain() source

resolve class extends chain. add following special property.

  • _custom_extends_chain: ancestor class chain.
  • _custom_direct_subclasses: class list that direct extends target doc.
  • _custom_indirect_subclasses: class list that indirect extends target doc.
  • _custom_indirect_implements: class list that target doc indirect implements.
  • _custom_direct_implemented: class list that direct implements target doc.
  • _custom_indirect_implemented: class list that indirect implements target doc.

private _resolveIgnore() source

resolve ignore property. remove docs that has ignore property.

Test:

private _resolveLink() source

resolve @link as html link.

TODO:

  • resolve all ``description`` property.

private _resolveMarkdown() source

resolve description as markdown.

private _resolveNecessary() source

resolve necessary identifier.

class Foo {}

export default Bar extends Foo {}

Foo is not exported, but Bar extends Foo. Foo is necessary. So, Foo must be exported by force.

private _resolveTestRelation() source

resolve test and identifier relation. add special property.

  • _custom_tests: longnames of test doc.
  • _custom_test_targets: longnames of identifier.

private _resolveUndocumentIdentifier() source

resolve undocument identifier doc. doc is added ignore property that does not have document tag.

private _resolveUnexportIdentifier() source

resolve unexport identifier doc. doc is added ignore property that is not exported.