reference

Documentation

Overview

Package reference handles resolving of reference types within the API documentation. It resolves the struct types recursively.

Index

• type Resolver
  • func NewResolver(verbose bool) Resolver

Types

type Resolver

type Resolver interface {
	// Resolve endpoints references.
	// The resolved references are injected into the block's lines
	Resolve(endpoints []extract.Block) error
}

Resolver of references

func NewResolver

func NewResolver(verbose bool) Resolver

NewResolver instance