build

type Config struct {
	// 文档的版本信息
	//
	// 程序会用此来判断程序的兼容性。
	Version string `yaml:"version"`

	// 输入的配置项，可以指定多个项目
	//
	// 多语言项目，可能需要用到多个输入面。
	Inputs []*Input `yaml:"inputs"`

	// 输出配置项
	Output *Output `yaml:"output"`
}

type Input struct {
	// 输入的目标语言
	//
	// 取值为 lang.Language.Name
	Lang string `yaml:"lang"`

	// 源代码目录
	Dir core.URI `yaml:"dir"`

	// 需要扫描的文件扩展名
	//
	// 若未指定，则根据 Lang 选项获取其默认的扩展名作为过滤条件。
	Exts []string `yaml:"exts,omitempty"`

	// 是否查找 Dir 的子目录
	Recursive bool `yaml:"recursive,omitempty"`

	// 源文件的编码，默认为 UTF-8
	Encoding string `yaml:"encoding,omitempty"`
	// contains filtered or unexported fields
}

type Output struct {
	// 文档的版本号
	//
	// 该值会覆盖文档中 apidoc.version 的值，方便用户通过代码层面进行版本号同步，
	// 该值无法通过配置文件设置，只能由代码进行设置。
	Version string `yaml:"-"`

	// 导出的文件类型格式，默认为 apidoc 的 XML 文件。
	Type string `yaml:"type,omitempty"`

	// 文档的保存路径
	//
	// 仅适用本地路径
	Path core.URI `yaml:"path"`

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

	// xslt 文件地址
	//
	// 默认值为 https://apidoc.tools/docs/ 下当前版本的 apidoc.xsl，比如：
	//  https://apidoc.tools/docs/v7/apidoc.xsl
	//
	// NOTE: 仅针对 xml 类型的输出文件
	Style string `yaml:"style,omitempty"`

	// 命名空间的相关设置
	//
	// 当 namespace 为 true 时会在文档中输出以 core.XMLNamespace 作为命名空间的值，
	// 如果还指定了 NamespacePrefix 则会以此值作为前缀值。
	// NamespacePrefix 仅在 Namespace 为 true 时才启作用。
	//
	// NOTE: 仅针对 Type = APIDocXML
	Namespace       bool   `yaml:"namespace,omitempty"`
	NamespacePrefix string `yaml:"namespace-prefix,omitempty"`
	// contains filtered or unexported fields
}

type PackOptions struct {
	Path       string
	PkgName    string
	VarName    string
	FileHeader string // 在文件头的输出内容，可以为空。
	Tag        string // 指定 +build 指令的标签，可以为空，表示不需要
}