comments

Author: rajveermalviya

gen/main.go

@@ -31,14 +31,17 @@ func main() {
 		os.Exit(1)
 	}
 
+	// Order matters for validation steps, so enforce it.
 	if len(yamlPaths) > 1 && filepath.Base(yamlPaths[0]) != "webgpu.yml" {
 		panic(`"webgpu.yml" must be the first sequence in the order`)
 	}
 
+	// Validate the yaml files (jsonschema, duplications)
 	if err := ValidateYamls(schemaPath, yamlPaths); err != nil {
 		panic(err)
 	}
 
+	// Generate the header files
 	for i, yamlPath := range yamlPaths {
 		src, err := os.ReadFile(yamlPath)
 		if err != nil {
@@ -84,6 +87,7 @@ func SortAndTransform(yml *Yml) {
 
 	// Sort enums
 	slices.SortStableFunc(yml.Enums, func(a, b Enum) int {
+		// We want to generate extended enum declarations before the normal ones.
 		if a.Extended && !b.Extended {
 			return -1
 		} else if !a.Extended && b.Extended {

gen/validator.go

@@ -12,6 +12,7 @@ import (
 )
 
 func ValidateYamls(schemaPath string, yamlPaths []string) error {
+	// Validation through json schema
 	for _, yamlPath := range yamlPaths {
 		yamlFile, err := os.ReadFile(yamlPath)
 		if err != nil {
@@ -28,6 +29,7 @@ func ValidateYamls(schemaPath string, yamlPaths []string) error {
 		}
 	}
 
+	// Validation of possible duplication of entries across multiple yaml files
 	if err := mergeAndValidateDuplicates(yamlPaths); err != nil {
 		panic(err)
 	}