github.com/rmarku/gomarkdoc@v0.0.0-20230517164305-78688ebe4325/testData/unexported/README.md (about)

     1  <!-- Code generated by gomarkdoc. DO NOT EDIT -->
     2  
     3  # unexported
     4  
     5  ```go
     6  import "github.com/rmarku/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  <a name="Num"></a>
    19  
    20  ## type [Num](https://github.com/rmarku/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  
    32  ### func [AddNums](https://github.com/rmarku/gomarkdoc/blob/master/testData/unexported/main.go#L16)
    33  
    34  ```go
    35  func AddNums(num1, num2 Num) Num
    36  ```
    37  
    38  AddNums adds two Nums together.
    39  
    40  <a name="addInternal"></a>
    41  
    42  ### func [addInternal](https://github.com/rmarku/gomarkdoc/blob/master/testData/unexported/main.go#L21)
    43  
    44  ```go
    45  func addInternal(num1, num2 Num) Num
    46  ```
    47  
    48  addInternal is a private version of AddNums.
    49  
    50  <a name="Num.Add"></a>
    51  
    52  ### func \(Num\) [Add](https://github.com/rmarku/gomarkdoc/blob/master/testData/unexported/main.go#L11)
    53  
    54  ```go
    55  func (n Num) Add(num Num) Num
    56  ```
    57  
    58  Add adds the other num to this one.
    59  
    60  Generated by [gomarkdoc](https://github.com/rmarku/gomarkdoc)