format

package

v2.0.0-rc6 Latest Latest Go to latest Published: Oct 3, 2023 License: MIT Imports: 4 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/5999ft/swag

Documentation ¶

Index ¶

type Config
type Format
- func New() *Format
- func (f *Format) Build(config *Config) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	// SearchDir the swag would be parse
	SearchDir string

	// excludes dirs and files in SearchDir,comma separated
	Excludes string

	// MainFile (DEPRECATED)
	MainFile string
}

Config specifies configuration for a format run

type Format ¶

type Format struct {
	// contains filtered or unexported fields
}

Format implements `fmt` command for formatting swag comments in Go source files.

func New ¶

func New() *Format

New creates a new Format instance

func (*Format) Build ¶

func (f *Format) Build(config *Config) error

Build runs formatter according to configuration in config

Source Files ¶

View all Source files

format.go

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