Documentation ¶
Overview ¶
Package example is an example of various documentation abilities and edge cases.
This is paragraph text in the middle of things.
here is some indented stuff
blurp.
Example (Of_stuff) ¶
Example_of_stuff shows an example of various random things.
package main import ( "fmt" "github.com/AstromechZA/godork/example" ) func main() { fmt.Println(example.T0, example.T1, example.T2) }
Output: 0 1 2
Index ¶
Examples ¶
Constants ¶
View Source
const ( T0 int = iota T1 T2 )
Numbered test constants
View Source
const Something = "word"
Something is a test string used in various scenarios.
Variables ¶
View Source
var ( Hi = "Hello" Byte = "Good bye" )
Some other variables.
View Source
var DefaultName = "godork"
DefaultName is a mutable variable used to store a string used in various default scenarios when an override is not provided.
Functions ¶
Types ¶
type SomeType ¶
type SomeType struct { // External is the verbleburble External int // contains filtered or unexported fields }
SomeType is a struct holding the state of the example struct type. A bunch of content here
indent
stuff.
func (*SomeType) PointerReceiver ¶
PointerReceiver is an example of a method with a pointer rcvr
Example ¶
package main import ( "github.com/AstromechZA/godork/example" ) func main() { t := example.SomeType{} t.PointerReceiver(1) }
Output: 1
func (SomeType) ValueReceiver ¶
ValueReceiver is an example of a method with a value rcvr
Click to show internal directories.
Click to hide internal directories.