README
¶
docs
import "github.com/cloudogu/gomarkdoc/testData/docs"
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@v0.5.0/bcrypt.Cost], an external link Outside Link and a [broken link].
It also has a numbered list:
- First
- Second
- Third
Plus one with blank lines:
-
First
-
Second
-
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
Index
func Func
func Func(param int) int
Func is present in this file.
type Type
Type is a type in this file.
type Type struct{}
func (*Type) Func
func (t *Type) Func()
TypeFunc is a func within a type in this file.
Generated by gomarkdoc
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@v0.5.0/bcrypt.Cost], an external link Outside Link and a [broken link].
It also has a numbered list:
- First
- Second
- Third
Plus one with blank lines:
First
Second
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
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Source Files