syntax

package

v0.0.0-...-3fcfa23 Latest Latest Go to latest Published: Jul 31, 2018 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/tanxiaolong/apidoc

Documentation ¶

Overview ¶

Package syntax 负责对标签语法的解析操作。

Index ¶

func OutputError(l *log.Logger, file string, line int, format string, v ...interface{})
func Parse(input *Input, d *types.Doc)
type Input

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func OutputError ¶

func OutputError(l *log.Logger, file string, line int, format string, v ...interface{})

OutputError 向日志通道输出一条语法错误信息 file 错误所在的文件； line 错误所在的行号；

func Parse ¶

func Parse(input *Input, d *types.Doc)

Parse 分析一段代码，并将结果保存到 d 中。

若出错，则会在 Input.Error 中输出错误信息，并中断解析，也不会在 d 中添加任何内容；若是警告信息，会继续执行。

Types ¶

type Input ¶

type Input struct {
	File  string      // 该段代码所在的文件
	Line  int         // 该段代码在文件中的行号
	Data  []rune      // 需要解析的代码段
	Error *log.Logger // 出错时的输出通道
	Warn  *log.Logger // 警告信息的输出通道
}

Input 由外界提供的与标签语法相关的内容。

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL