Move mainpag documentation to yml file

so that extensions can have their own.
webgpu-native · Dec 5, 2024 · 5ed252c · 5ed252c
1 parent 1d18dcc
commit 5ed252c
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 15 deletions.
diff --git a/gen/cheader.tmpl b/gen/cheader.tmpl
@@ -1,21 +1,7 @@
 {{- MCommentN .Copyright 0}}
 
 /** @file */
-
-/**
- * \mainpage
- *
- * **Important:** *This documentation is a Work In Progress.*
- *
- * This is the home of WebGPU C API specification. We define here the standard
- * `webgpu.h` header that all implementations should provide.
- *
- * For all details where behavior is not otherwise specified, `webgpu.h` has
- * the same behavior as the WebGPU specification for JavaScript on the Web.
- * The WebIDL-based Web specification is mapped into C as faithfully (and
- * bidirectionally) as practical/possible.
- * The working draft of WebGPU can be found at <https://www.w3.org/TR/webgpu/>.
- */
+{{MComment (print "\\mainpage\n" .Doc) 0}}
 
 #ifndef {{.HeaderName | ConstantCase}}_H_
 #define {{.HeaderName | ConstantCase}}_H_

diff --git a/gen/yml.go b/gen/yml.go
@@ -10,6 +10,7 @@ import (
 type Yml struct {
 	Copyright  string `yaml:"copyright"`
 	Name       string `yaml:"name"`
+	Doc        string `yaml:"doc"`
 	EnumPrefix string `yaml:"enum_prefix"`
 
 	Constants []Constant `yaml:"constants"`

diff --git a/schema.json b/schema.json
@@ -256,6 +256,9 @@
             "pattern": "^0x[0-9]{4}$",
             "description": "The dedicated enum prefix for the implementation specific header to avoid collisions"
         },
+        "doc": {
+            "type": "string"
+        },
         "typedefs": {
             "type": "array",
             "items": {
@@ -516,6 +519,7 @@
         "copyright",
         "name",
         "enum_prefix",
+        "doc",
         "constants",
         "typedefs",
         "enums",

diff --git a/webgpu.yml b/webgpu.yml
@@ -4,6 +4,17 @@ copyright: |
   SPDX-License-Identifier: BSD-3-Clause
 name: webgpu
 enum_prefix: '0x0000'
+doc: |
+  **Important:** *This documentation is a Work In Progress.*
+  
+  This is the home of WebGPU C API specification. We define here the standard
+  `webgpu.h` header that all implementations should provide.
+  
+  For all details where behavior is not otherwise specified, `webgpu.h` has
+  the same behavior as the WebGPU specification for JavaScript on the Web.
+  The WebIDL-based Web specification is mapped into C as faithfully (and
+  bidirectionally) as practical/possible.
+  The working draft of WebGPU can be found at <https://www.w3.org/TR/webgpu/>.
 constants:
   - name: array_layer_count_undefined
     value: uint32_max