github.com/Finschia/finschia-sdk@v0.48.1/docs/protodoc-markdown.tmpl (about)

     1  <!-- This file is auto-generated. Please do not modify it yourself. -->
     2  # Protobuf Documentation
     3  <a name="top"></a>
     4  
     5  ## Table of Contents
     6  {{range .Files}}
     7  {{$file_name := .Name}}- [{{.Name}}](#{{.Name}})
     8    {{- if .Messages }}
     9    {{range .Messages}}  - [{{.LongName}}](#{{.FullName}})
    10    {{end}}
    11    {{- end -}}
    12    {{- if .Enums }}
    13    {{range .Enums}}  - [{{.LongName}}](#{{.FullName}})
    14    {{end}}
    15    {{- end -}}
    16    {{- if .Extensions }}
    17    {{range .Extensions}}  - [File-level Extensions](#{{$file_name}}-extensions)
    18    {{end}}
    19    {{- end -}}
    20    {{- if .Services }}
    21    {{range .Services}}  - [{{.Name}}](#{{.FullName}})
    22    {{end}}
    23    {{- end -}}
    24  {{end}}
    25  - [Scalar Value Types](#scalar-value-types)
    26  
    27  {{range .Files}}
    28  {{$file_name := .Name}}
    29  <a name="{{.Name}}"></a>
    30  <p align="right"><a href="#top">Top</a></p>
    31  
    32  ## {{.Name}}
    33  {{.Description}}
    34  
    35  {{range .Messages}}
    36  <a name="{{.FullName}}"></a>
    37  
    38  ### {{.LongName}}
    39  {{.Description}}
    40  
    41  {{if .HasFields}}
    42  | Field | Type | Label | Description |
    43  | ----- | ---- | ----- | ----------- |
    44  {{range .Fields -}}
    45    | `{{.Name}}` | [{{.LongType}}](#{{.FullType}}) | {{.Label}} | {{if (index .Options "deprecated"|default false)}}**Deprecated.** {{end}}{{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
    46  {{end}}
    47  {{end}}
    48  
    49  {{if .HasExtensions}}
    50  | Extension | Type | Base | Number | Description |
    51  | --------- | ---- | ---- | ------ | ----------- |
    52  {{range .Extensions -}}
    53    | `{{.Name}}` | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
    54  {{end}}
    55  {{end}}
    56  
    57  {{end}} <!-- end messages -->
    58  
    59  {{range .Enums}}
    60  <a name="{{.FullName}}"></a>
    61  
    62  ### {{.LongName}}
    63  {{.Description}}
    64  
    65  | Name | Number | Description |
    66  | ---- | ------ | ----------- |
    67  {{range .Values -}}
    68    | {{.Name}} | {{.Number}} | {{nobr .Description}} |
    69  {{end}}
    70  
    71  {{end}} <!-- end enums -->
    72  
    73  {{if .HasExtensions}}
    74  <a name="{{$file_name}}-extensions"></a>
    75  
    76  ### File-level Extensions
    77  | Extension | Type | Base | Number | Description |
    78  | --------- | ---- | ---- | ------ | ----------- |
    79  {{range .Extensions -}}
    80    | `{{.Name}}` | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} |
    81  {{end}}
    82  {{end}} <!-- end HasExtensions -->
    83  
    84  {{range .Services}}
    85  <a name="{{.FullName}}"></a>
    86  
    87  ### {{.Name}}
    88  {{.Description}}
    89  
    90  | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint |
    91  | ----------- | ------------ | ------------- | ------------| ------- | -------- |
    92  {{range .Methods -}}
    93    | `{{.Name}}` | [{{.RequestLongType}}](#{{.RequestFullType}}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseFullType}}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} | {{with (index .Options "google.api.http")}}{{range .Rules}}{{.Method}}|{{.Pattern}}{{end}}{{end}}|
    94  {{end}}
    95  {{end}} <!-- end services -->
    96  
    97  {{end}}
    98  
    99  ## Scalar Value Types
   100  
   101  | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
   102  | ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
   103  {{range .Scalars -}}
   104    | <a name="{{.ProtoType}}" /> {{.ProtoType}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | {{.PythonType}} | {{.GoType}} | {{.CSharp}} | {{.PhpType}} | {{.RubyType}} |
   105  {{end}}