docs

Documentation

Overview

Package docs exercises the documentation features of golang 1.19 and above at the package documentation level.

This is a heading

This heading has a paragraph with a reference to the standard library math/rand as well as a function in the file Func, a type Type, a type's function Type.Func, a non-standard library package golang.org/x/crypto/bcrypt.Cost, an external link Outside Link and a [broken link]. We can also place links directly like https://github.com which get turned into links.

It also has a numbered list:

1. First
2. Second
3. Third

Plus one with blank lines:

1. First

2. Second

3. Third

Non-numbered lists

• First another line
• Second
• Third

Plus blank lines:

• First

  another paragraph

• Second

• Third

And a golang code block:

func GolangCode(t int) int {
	return t + 1
}

And a random code block:

something
	preformatted
in a random
		way

There's also another file with a struct called AnotherStruct that has additional methods and fields.

We also have constants like Constant and Const1 plus variables like Var and and VarB.

Index

• Constants
• Variables
• func Func(param int) int
• type AnotherStruct
  • func NewAnotherStruct() *AnotherStruct
  • func (s *AnotherStruct) GetField() string
• type Type
  • func (t *Type) Func()

Constants

const (
	Const1 = 1
	Const2 = 2
	Const3 = 3
)

This is a constant block

const Constant = 3

Constant is a constant.

Variables

var (
	VarA = 'a'
	VarB = 'b'
	VarC = 'c'
)

This is a var block

var Var = 2

Var is a var.

Functions

func Func

func Func(param int) int

Func is present in this file.

Types

type AnotherStruct

type AnotherStruct struct {
	Field string
}

AnotherStruct has methods like *AnotherStruct.GetField and also has an initializer called NewAnotherStruct.

func NewAnotherStruct

func NewAnotherStruct() *AnotherStruct

NewAnotherStruct() makes *AnotherStruct.

func (*AnotherStruct) GetField

func (s *AnotherStruct) GetField() string

GetField gets [*AnotherStruct.Field].

type Type

type Type struct{}

Type is a type in this file.

func (*Type) Func

func (t *Type) Func()

TypeFunc is a func within a type in this file.