github.com/phsym/gomarkdoc@v0.5.4/testData/unexported/README.md (about)

     1  <!-- Code generated by gomarkdoc. DO NOT EDIT -->
     2  
     3  # unexported
     4  
     5  ```go
     6  import "github.com/phsym/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](<#type-num>)
    14    - [func AddNums(num1, num2 Num) Num](<#func-addnums>)
    15    - [func addInternal(num1, num2 Num) Num](<#func-addinternal>)
    16    - [func (n Num) Add(num Num) Num](<#func-num-add>)
    17  
    18  
    19  ## type [Num](<https://github.com/phsym/gomarkdoc/blob/master/testData/unexported/main.go#L8>)
    20  
    21  Num is a number.
    22  
    23  It is just a test type so that we can make sure this works.
    24  
    25  ```go
    26  type Num int
    27  ```
    28  
    29  ### func [AddNums](<https://github.com/phsym/gomarkdoc/blob/master/testData/unexported/main.go#L16>)
    30  
    31  ```go
    32  func AddNums(num1, num2 Num) Num
    33  ```
    34  
    35  AddNums adds two Nums together.
    36  
    37  ### func [addInternal](<https://github.com/phsym/gomarkdoc/blob/master/testData/unexported/main.go#L21>)
    38  
    39  ```go
    40  func addInternal(num1, num2 Num) Num
    41  ```
    42  
    43  addInternal is a private version of AddNums.
    44  
    45  ### func \(Num\) [Add](<https://github.com/phsym/gomarkdoc/blob/master/testData/unexported/main.go#L11>)
    46  
    47  ```go
    48  func (n Num) Add(num Num) Num
    49  ```
    50  
    51  Add adds the other num to this one.
    52  
    53  
    54  
    55  Generated by [gomarkdoc](<https://github.com/phsym/gomarkdoc>)