github.com/anthonyme00/gomarkdoc@v1.0.0/testData/unexported/README-plain.md (about)

     1  <!-- Code generated by gomarkdoc. DO NOT EDIT -->
     2  
     3  # unexported
     4  
     5  	import "github.com/anthonyme00/gomarkdoc/testData/unexported"
     6  
     7  Package unexported contains some simple code to exercise basic scenarios for documentation purposes.
     8  
     9  ## Index
    10  
    11  - [type Num](<#Num>)
    12    - [func AddNums\(num1, num2 Num\) Num](<#AddNums>)
    13    - [func addInternal\(num1, num2 Num\) Num](<#addInternal>)
    14    - [func \(n Num\) Add\(num Num\) Num](<#Num.Add>)
    15  
    16  
    17  <a name="Num"></a>
    18  ## type Num
    19  
    20  Num is a number.
    21  
    22  It is just a test type so that we can make sure this works.
    23  
    24  	type Num int
    25  
    26  <a name="AddNums"></a>
    27  ### func AddNums
    28  
    29  	func AddNums(num1, num2 Num) Num
    30  
    31  AddNums adds two Nums together.
    32  
    33  <a name="addInternal"></a>
    34  ### func addInternal
    35  
    36  	func addInternal(num1, num2 Num) Num
    37  
    38  addInternal is a private version of AddNums.
    39  
    40  <a name="Num.Add"></a>
    41  ### func \(Num\) Add
    42  
    43  	func (n Num) Add(num Num) Num
    44  
    45  Add adds the other num to this one.
    46  
    47  Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)