Improve generated comments

goadesign · Nov 26, 2024 · 879a0fe · 879a0fe
1 parent 02a856d
commit 879a0fe
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 7 deletions.
diff --git a/codegen/service/interceptors.go b/codegen/service/interceptors.go
@@ -33,6 +33,7 @@ type (
 	// InterceptorData describes a single interceptor.
 	InterceptorData struct {
 		Name                    string
+		DesignName              string
 		UnexportedName          string
 		Description             string
 		PayloadRef              string
@@ -150,6 +151,7 @@ func buildMethodInterceptors(m *expr.MethodExpr, scope *codegen.NameScope) ([]*I
 
 		return &InterceptorData{
 			Name:                    codegen.Goify(intr.Name, true),
+			DesignName:              intr.Name,
 			UnexportedName:          codegen.Goify(intr.Name, false),
 			Description:             intr.Description,
 			PayloadRef:              methodData.PayloadRef,

diff --git a/codegen/service/templates/client_wrappers.go.tpl b/codegen/service/templates/client_wrappers.go.tpl
@@ -7,7 +7,7 @@ func Wrap{{ .MethodVarName }}ClientEndpoint(endpoint goa.Endpoint, i ClientInter
 }
 
 {{- range .ClientInterceptors }}
-{{ comment (printf "wrapClient%s applies the %s interceptor to endpoints." .Name .Name) }}
+{{ comment (printf "wrapClient%s applies the %s interceptor to endpoints." .Name .DesignName) }}
 func wrapClient{{ .Name }}(endpoint goa.Endpoint, i ClientInterceptors, method string) goa.Endpoint {
     return func(ctx context.Context, req any) (any, error) {
         info := &{{ .Name }}Info{

diff --git a/codegen/service/templates/endpoint_wrappers.go.tpl b/codegen/service/templates/endpoint_wrappers.go.tpl
@@ -7,7 +7,7 @@ func Wrap{{ .MethodVarName }}Endpoint(endpoint goa.Endpoint, i ServerInterceptor
 }
 
 {{- range .ServerInterceptors }}
-{{ comment (printf "wrap%s applies the %s interceptor to endpoints." .Name .Name) }}
+{{ comment (printf "wrap%s applies the %s interceptor to endpoints." .Name .DesignName) }}
 func wrap{{ .Name }}(endpoint goa.Endpoint, i ServerInterceptors, method string) goa.Endpoint {
 	return func(ctx context.Context, req any) (any, error) {
 		info := &{{ .Name }}Info{

diff --git a/codegen/service/testdata/client_code.go b/codegen/service/testdata/client_code.go
@@ -315,7 +315,7 @@ func WrapMethodClientEndpoint(endpoint goa.Endpoint, i ClientInterceptors) goa.E
 	return endpoint
 }
 
-// wrapClientTracing applies the Tracing interceptor to endpoints.
+// wrapClientTracing applies the tracing interceptor to endpoints.
 func wrapClientTracing(endpoint goa.Endpoint, i ClientInterceptors, method string) goa.Endpoint {
 	return func(ctx context.Context, req any) (any, error) {
 		info := &TracingInfo{

diff --git a/codegen/service/testdata/endpoint_code.go b/codegen/service/testdata/endpoint_code.go
@@ -551,7 +551,7 @@ func WrapMethodEndpoint(endpoint goa.Endpoint, i ServerInterceptors) goa.Endpoin
 	return endpoint
 }
 
-// wrapLogging applies the Logging interceptor to endpoints.
+// wrapLogging applies the logging interceptor to endpoints.
 func wrapLogging(endpoint goa.Endpoint, i ServerInterceptors, method string) goa.Endpoint {
 	return func(ctx context.Context, req any) (any, error) {
 		info := &LoggingInfo{
@@ -605,7 +605,7 @@ func WrapMethodEndpoint(endpoint goa.Endpoint, i ServerInterceptors) goa.Endpoin
 	return endpoint
 }
 
-// wrapLogging applies the Logging interceptor to endpoints.
+// wrapLogging applies the logging interceptor to endpoints.
 func wrapLogging(endpoint goa.Endpoint, i ServerInterceptors, method string) goa.Endpoint {
 	return func(ctx context.Context, req any) (any, error) {
 		info := &LoggingInfo{
@@ -621,7 +621,7 @@ func wrapLogging(endpoint goa.Endpoint, i ServerInterceptors, method string) goa
 	}
 }
 
-// wrapMetrics applies the Metrics interceptor to endpoints.
+// wrapMetrics applies the metrics interceptor to endpoints.
 func wrapMetrics(endpoint goa.Endpoint, i ServerInterceptors, method string) goa.Endpoint {
 	return func(ctx context.Context, req any) (any, error) {
 		info := &MetricsInfo{
@@ -679,7 +679,7 @@ func WrapMethodEndpoint(endpoint goa.Endpoint, i ServerInterceptors) goa.Endpoin
 	return endpoint
 }
 
-// wrapLogging applies the Logging interceptor to endpoints.
+// wrapLogging applies the logging interceptor to endpoints.
 func wrapLogging(endpoint goa.Endpoint, i ServerInterceptors, method string) goa.Endpoint {
 	return func(ctx context.Context, req any) (any, error) {
 		info := &LoggingInfo{