github.com/phsym/gomarkdoc@v0.5.4/testData/simple/main.go (about)

     1  // Package simple contains, some simple code to exercise basic scenarios
     2  // for documentation purposes.
     3  package simple
     4  
     5  // Num is a number.
     6  //
     7  // It is just a test type so that we can make sure this works.
     8  type Num int
     9  
    10  // Add adds the other num to this one.
    11  func (n Num) Add(num Num) Num {
    12  	return addInternal(n, num)
    13  }
    14  
    15  // AddNums adds two Nums together.
    16  func AddNums(num1, num2 Num) Num {
    17  	return addInternal(num1, num2)
    18  }
    19  
    20  // addInternal is a private version of AddNums.
    21  func addInternal(num1, num2 Num) Num {
    22  	return num1 + num2
    23  }