Generate a doc string comment for the record (#187)

nginxinc · Aug 12, 2024 · 225a680 · 225a680
1 parent 6c5079e
commit 225a680
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/cmd/generator/scheme.go b/cmd/generator/scheme.go
@@ -10,6 +10,7 @@ import (
 )
 
 const schemeTemplate = `@namespace("{{ .Namespace }}") protocol {{ .Protocol }} {
+	/** {{ .Record }} is the telemetry data for the product. */
 	@df_datatype("{{ .DataFabricDataType }}") record {{ .Record }} {
 		/** The field that identifies what type of data this is. */
 		string dataType;

diff --git a/cmd/generator/tests/data.avdl b/cmd/generator/tests/data.avdl
@@ -1,4 +1,5 @@
 @namespace("gateway.nginx.org") protocol NGFProductTelemetry {
+	/** Data is the telemetry data for the product. */
 	@df_datatype("ngf-product-telemetry") record Data {
 		/** The field that identifies what type of data this is. */
 		string dataType;