simple

README

simple

import "github.com/phsym/gomarkdoc/testData/simple"

Package simple contains, some simple code to exercise basic scenarios for documentation purposes.

Index

• type Num
  • func AddNums(num1, num2 Num) Num
  • func (n Num) Add(num Num) Num

type Num

Num is a number.

It is just a test type so that we can make sure this works.

type Num int

func AddNums

func AddNums(num1, num2 Num) Num

AddNums adds two Nums together.

func (Num) Add

func (n Num) Add(num Num) Num

Add adds the other num to this one.

Generated by gomarkdoc

Documentation

Overview

Package simple contains, some simple code to exercise basic scenarios for documentation purposes.

Index

• type Num
  • func AddNums(num1, num2 Num) Num
  • func (n Num) Add(num Num) Num

Types

type Num

type Num int

Num is a number.

It is just a test type so that we can make sure this works.

func AddNums

func AddNums(num1, num2 Num) Num

AddNums adds two Nums together.

func (Num) Add

func (n Num) Add(num Num) Num

Add adds the other num to this one.