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

     1  <!-- Code generated by gomarkdoc. DO NOT EDIT -->
     2  
     3  # simple
     4  
     5  ```go
     6  import "github.com/rmarku/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  <a name="Num"></a>
    18  
    19  ## type [Num](https://github.com/rmarku/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  
    31  ### func [AddNums](https://github.com/rmarku/gomarkdoc/blob/master/testData/simple/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="Num.Add"></a>
    40  
    41  ### func \(Num\) [Add](https://github.com/rmarku/gomarkdoc/blob/master/testData/simple/main.go#L11)
    42  
    43  ```go
    44  func (n Num) Add(num Num) Num
    45  ```
    46  
    47  Add adds the other num to this one.
    48  
    49  Generated by [gomarkdoc](https://github.com/rmarku/gomarkdoc)