github.com/dkischenko/gomarkdoc@v0.0.0-20230516135336-e40deae8a495/testData/simple/README.md (about)

     1  <!-- Code generated by gomarkdoc. DO NOT EDIT -->
     2  
     3  # simple
     4  
     5  ```go
     6  import "github.com/dkischenko/gomarkdoc/testData/simple"
     7  ```
     8  
     9  Package simple 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 (n Num) Add(num Num) Num](<#Num.Add>)
    16  
    17  
    18  <a name="Num"></a>
    19  ## type [Num](<https://github.com/dkischenko/gomarkdoc/blob/master/testData/simple/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  <a name="AddNums"></a>
    30  ### func [AddNums](<https://github.com/dkischenko/gomarkdoc/blob/master/testData/simple/main.go#L16>)
    31  
    32  ```go
    33  func AddNums(num1, num2 Num) Num
    34  ```
    35  
    36  AddNums adds two Nums together.
    37  
    38  <a name="Num.Add"></a>
    39  ### func \(Num\) [Add](<https://github.com/dkischenko/gomarkdoc/blob/master/testData/simple/main.go#L11>)
    40  
    41  ```go
    42  func (n Num) Add(num Num) Num
    43  ```
    44  
    45  Add adds the other num to this one.
    46  
    47  Generated by [gomarkdoc](<https://github.com/dkischenko/gomarkdoc>)