Skip to content

Commit 936e27c

Browse files
committed
fix descriptions of interfaces
1 parent 9b51ad2 commit 936e27c

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

templates/go/api.mustache

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,27 +19,26 @@ import (
1919
type {{classname}} interface {
2020
{{#operation}}
2121
/*
22-
{{operationId}} {{{summary}}}{{^summary}}Method for {{operationId}}{{/summary}}
23-
{{#notes}}
24-
25-
{{#isDeprecated}}Deprecated: {{/isDeprecated}}{{{unescapedNotes}}}
26-
{{/notes}}
22+
{{operationId}} {{{summary}}}{{^summary}}Method for {{operationId}}{{/summary}}
23+
{{#notes}}
24+
{{#isDeprecated}}Deprecated: {{/isDeprecated}}{{{unescapedNotes}}}
25+
{{/notes}}
2726

28-
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().{{#pathParams}}
29-
@param {{paramName}}{{#description}} {{{.}}}{{/description}}{{/pathParams}}
30-
@return {{#structPrefix}}{{&classname}}{{/structPrefix}}{{^structPrefix}}Api{{/structPrefix}}{{operationId}}Request
27+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().{{#pathParams}}
28+
@param {{paramName}}{{#description}} {{{.}}}{{/description}}{{/pathParams}}
29+
@return {{#structPrefix}}{{&classname}}{{/structPrefix}}{{^structPrefix}}Api{{/structPrefix}}{{operationId}}Request
3130
*/
3231
{{{nickname}}}(ctx context.Context{{#pathParams}}, {{paramName}} {{{dataType}}}{{/pathParams}}) {{#structPrefix}}{{&classname}}{{/structPrefix}}{{^structPrefix}}Api{{/structPrefix}}{{operationId}}Request
33-
3432
/*
35-
{{nickname}}Execute executes the request{{#returnType}}
36-
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().{{#pathParams}}
37-
@param {{paramName}}{{#description}} {{{.}}}{{/description}}{{/pathParams}}
38-
@return {{{.}}}{{/returnType}}
39-
40-
{{#isDeprecated}}
41-
Deprecated: {{{unescapedNotes}}}
42-
{{/isDeprecated}}
33+
{{nickname}}Execute executes the request{{#returnType}}
34+
35+
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().{{#pathParams}}
36+
@param {{paramName}}{{#description}} {{{.}}}{{/description}}{{/pathParams}}
37+
@return {{{.}}}{{/returnType}}
38+
39+
{{#isDeprecated}}
40+
Deprecated: {{{unescapedNotes}}}
41+
{{/isDeprecated}}
4342
*/
4443
{{nickname}}Execute(ctx context.Context{{#pathParams}}, {{paramName}} {{{dataType}}}{{/pathParams}}) ({{#returnType}}{{^isArray}}{{^returnTypeIsPrimitive}}{{^isResponseFile}}*{{/isResponseFile}}{{/returnTypeIsPrimitive}}{{/isArray}}{{{.}}}, {{/returnType}} error)
4544
{{/operation}}

0 commit comments

Comments
 (0)