options

Documentation

Overview

Package options 输入和输出的配置项

Index

• Constants
• type Input
  • func Detect(dir string, recursive bool) ([]*Input, error)
• type Output

Constants

const (
	ApidocJSON  = "apidoc+json"
	ApidocYAML  = "apidoc+yaml"
	OpenapiJSON = "openapi+json"
	OpenapiYAML = "openapi+yaml"
	RAMLYAML    = "raml+yaml"
)

文档类型定义

Types

type Input

type Input struct {
	Lang      string   `yaml:"lang"`               // 输入的目标语言
	Dir       string   `yaml:"dir"`                // 源代码目录，建议使用绝对路径
	Exts      []string `yaml:"exts,omitempty"`     // 需要扫描的文件扩展名，若未指定，则使用默认值
	Recursive bool     `yaml:"recursive"`          // 是否查找 Dir 的子目录
	Encoding  string   `yaml:"encoding,omitempty"` // 文件的编码，为空表示 utf-8
}

Input 指定输入内容的相关信息。

func Detect

func Detect(dir string, recursive bool) ([]*Input, error)

Detect 检测指定目录下的内容，并为其生成一个合适的 Input 实例。

检测依据为根据扩展名来做统计，数量最大且被支持的获胜。

type Output

type Output struct {
	// 文档的保存路径，建议使用绝对路径。
	Path string `yaml:"path,omitempty"`

	// 输出类型
	Type string `yaml:"type,omitempty"`

	// 只输出该标签的文档，若为空，则表示所有。
	Tags []string `yaml:"tags,omitempty"`
}

Output 指定了渲染输出的相关设置项。