github.com/ConsenSys/Quorum@v20.10.0+incompatible/plugin/gen/docs.markdown.tmpl (about)

     1  <!-- This is auto generated file from running `go generate` in plugin/proto folder. Please do not edit -->
     2  
     3  {{range .Files}}
     4  {{$file_name := .Name}}
     5  <a name="{{.Name}}"></a>
     6  
     7  ## {{.Name}}
     8  {{.Description}}
     9  
    10  ### Services
    11  
    12  {{range .Services}}
    13  <a name="{{.FullName}}"></a>
    14  
    15  #### `{{.Name}}`
    16  {{.Description}}
    17  
    18  | Method Name | Request Type | Response Type | Description |
    19  | ----------- | ------------ | ------------- | ------------|
    20  {{range .Methods -}}
    21    | {{.Name}} | [{{.RequestLongType}}](#{{.RequestFullType}}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseFullType}}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} |
    22  {{end}}
    23  {{end}} <!-- end services -->
    24  
    25  ### Messsages
    26  
    27  {{range .Messages}}
    28  <a name="{{.FullName}}"></a>
    29  
    30  #### `{{.LongName}}`
    31  {{.Description}}
    32  
    33  {{if .HasFields}}
    34  | Field | Type | Label | Description |
    35  | ----- | ---- | ----- | ----------- |
    36  {{range .Fields -}}
    37    | {{.Name}} | [{{.LongType}}](#{{.FullType}}) | {{.Label}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
    38  {{end}}
    39  {{end}}
    40  
    41  {{if .HasExtensions}}
    42  | Extension | Type | Base | Number | Description |
    43  | --------- | ---- | ---- | ------ | ----------- |
    44  {{range .Extensions -}}
    45    | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
    46  {{end}}
    47  {{end}}
    48  
    49  {{end}} <!-- end messages -->
    50  
    51  {{range .Enums}}
    52  <a name="{{.FullName}}"></a>
    53  
    54  #### `{{.LongName}}`
    55  {{.Description}}
    56  
    57  | Name | Number | Description |
    58  | ---- | ------ | ----------- |
    59  {{range .Values -}}
    60    | {{.Name}} | {{.Number}} | {{nobr .Description}} |
    61  {{end}}
    62  
    63  {{end}} <!-- end enums -->
    64  
    65  {{if .HasExtensions}}
    66  <a name="{{$file_name}}-extensions"></a>
    67  
    68  #### File-level Extensions
    69  | Extension | Type | Base | Number | Description |
    70  | --------- | ---- | ---- | ------ | ----------- |
    71  {{range .Extensions -}}
    72    | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} |
    73  {{end}}
    74  {{end}} <!-- end HasExtensions -->
    75  
    76  {{end}}