extract

Documentation

Overview

Package extract handles extraction of all raw API documentation lines and arrange them into main documentation block and a collection of endpoint documentation blocks.

Index

• type Block
• type Extractor
  • func NewExtractor(verbose bool) Extractor

Types

type Block

type Block struct {
	// File containing this block
	File string
	// Lines extracted from the file
	Lines []string
}

Block extracted raw documentation lines

type Extractor

type Extractor interface {
	// Extract the documentation from the file
	Extract(path string) ([]Block, error)
}

Extractor interface

func NewExtractor

func NewExtractor(verbose bool) Extractor

NewExtractor instance