full

Documentation

Overview

This is a file documentation.

Index

• Constants
• Variables
• func FunctionOne(a string, b interface{}, c map[string]interface{}) (ctx context.Context, err error)
• func FunctionTwo(f func(string, func() error))
• type InterfaceOne
• type StructOne
• type StructThree
• type StructTwo
  • func (m StructTwo) MethodOne() string
• type X
• type Y

Constants

const (
	ConstBlock1 uint32  = 7
	ConstBlock2 float32 = 1.0
)

This is a block comment.

const (
	Iota1 = iota + 1
	Iota2
	Iota3
)

const ConstInt = 5 // This is inline comment.

const ConstString = "this is string const"

This is a comment for string constant

Variables

var (
	BlockVarA = func(string) string { return "" }
	BlockVarB chan error
	BlockVarC func(string) string = BlockVarA
)

Block comment of variables.

var VarA string

var VarB = "var b"

var VarC string = "var c"

Functions

func FunctionOne

func FunctionOne(a string, b interface{}, c map[string]interface{}) (ctx context.Context, err error)

func FunctionTwo

func FunctionTwo(f func(string, func() error))

Types

type InterfaceOne

type InterfaceOne interface {
	InterfaceMethod(uint, ...complex64)
}

type StructOne

type StructOne struct {
	ExportedField string

	FieldWithTags int `json:"field_with_tags" sometag:"param1,param2,param3"`
	// Documentation of complex field.
	ComplexField chan<- *[]**map[interface {
		InterfaceMethod(uint, ...complex64)
	}]func(int, string, [7]byte) (complex64, error) // Inline comment of complex field.
	// contains filtered or unexported fields
}

type StructThree

type StructThree struct {
	StructTwo
	ExtendingField string
}

type StructTwo

type StructTwo struct {
	FieldOne   thisisstubalias.ThisIsStubStructure
	FieldTwo   []thisisstubalias.ThisIsStubStructure
	FieldThree *StructTwo
	FieldFour  []StructTwo
}

func (StructTwo) MethodOne

func (m StructTwo) MethodOne() string

type X

type X int

type Y

type Y string