docs

package
v0.0.0-...-db64682 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 20, 2023 License: MIT Imports: 0 Imported by: 0

README

docs

import "github.com/chengyumeng/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/bcrypt.Cost, an external link Outside Link and a [broken link].

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

This is a constant block

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

Constant is a constant.

const Constant = 3

Variables

This is a var block

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

Var is a var.

var Var = 2

func Func

func Func(param int) int

Func is present in this file.

type AnotherStruct

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

type AnotherStruct struct {
    Field string
}

func NewAnotherStruct
func NewAnotherStruct() *AnotherStruct

NewAnotherStruct() makes *AnotherStruct.

func (*AnotherStruct) GetField
func (s *AnotherStruct) GetField() string

GetField gets [*AnotherStruct.Field].

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/bcrypt.Cost, an external link Outside Link and a [broken link].

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

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

This is a constant block

View Source
const Constant = 3

Constant is a constant.

Variables

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

This is a var block

View Source
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.

Jump to

Keyboard shortcuts

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