update readme and test

microsoft · Dec 3, 2024 · f4a3f4d · f4a3f4d
1 parent b7c2cd5
commit f4a3f4d
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 10 deletions.
diff --git a/crates/libs/bindgen/Cargo.toml b/crates/libs/bindgen/Cargo.toml
@@ -4,7 +4,7 @@ version = "0.58.0"
 edition = "2021"
 rust-version = "1.74"
 license = "MIT OR Apache-2.0"
-description = "Windows code generator"
+description = "Code generator for Windows metadata"
 repository = "https://github.com/microsoft/windows-rs"
 readme = "readme.md"
 

diff --git a/crates/libs/bindgen/readme.md b/crates/libs/bindgen/readme.md
@@ -1,4 +1,4 @@
-## Generate Rust bindings for Windows
+## Code generator for Windows metadata
 
 The [windows-bindgen](https://crates.io/crates/windows-bindgen) crate automatically generates Rust bindings from Windows metadata.
 
@@ -16,23 +16,25 @@ version = "0.52"
 version = "0.58"
 ```
 
-Generates Rust bindings in a build script or test as needed:
+Generate Rust bindings in a build script as follows:
 
-```rust,ignore
-#[test]
-fn bindgen() {
+```rust
+fn main() {
     let args = [
         "--out",
         "src/bindings.rs",
-        "--config",
-        "flatten",
+        "--flat",
         "--filter",
-        "Windows.Win32.System.SystemInformation.GetTickCount",
+        "GetTickCount",
     ];
 
-    windows_bindgen::bindgen(args).unwrap();
+    windows_bindgen::bindgen(args);
 }
+```
+
+And then use the bindings as follows:
 
+```rust
 mod bindings;
 
 fn main() {

diff --git a/crates/tests/misc/readme/Cargo.toml b/crates/tests/misc/readme/Cargo.toml
@@ -21,6 +21,9 @@ features = [
     "Win32_UI_WindowsAndMessaging",
 ]
 
+[dev-dependencies.windows-bindgen]
+workspace = true
+
 [dependencies.windows-targets]
 workspace = true
 

diff --git a/crates/tests/misc/readme/src/bindings.rs b/crates/tests/misc/readme/src/bindings.rs
@@ -0,0 +1,15 @@
+// Bindings generated by `windows-bindgen` 0.58.0
+
+#![allow(
+    non_snake_case,
+    non_upper_case_globals,
+    non_camel_case_types,
+    dead_code,
+    clippy::all
+)]
+
+#[inline]
+pub unsafe fn GetTickCount() -> u32 {
+    windows_targets::link!("kernel32.dll" "system" fn GetTickCount() -> u32);
+    GetTickCount()
+}
diff --git a/crates/tests/misc/readme/src/lib.rs b/crates/tests/misc/readme/src/lib.rs
@@ -1,3 +1,4 @@
+#![doc = include_str!("../../../../libs/bindgen/readme.md")]
 #![doc = include_str!("../../../../libs/core/readme.md")]
 #![doc = include_str!("../../../../libs/cppwinrt/readme.md")]
 #![doc = include_str!("../../../../libs/registry/readme.md")]