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

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