Skip to content

Commit 5225b7c

Browse files
committed
update docs
1 parent 01ee02f commit 5225b7c

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

cpuid-bool/src/lib.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
//! Macro for checking CPU capabilities at runtime.
22
//!
3-
//! # Usage example
3+
//! # Example
44
//! ```
5+
//! // This macro creates `cpuid_aes_sha` module
56
//! cpuid_bool::new!(cpuid_aes_sha, "aes", "sha");
67
//!
78
//! // `token` is a Zero Sized Type value, which guarantees
89
//! // that underlying static storage got properly initialized,
910
//! // which allows to omit initialization branch
10-
//! let token = cpuid_aes_sha::init();
11+
//! let token: cpuid_aes_sha::InitToken = cpuid_aes_sha::init();
1112
//! if token.get() {
1213
//! println!("CPU supports both SHA and AES extensions");
1314
//! } else {

0 commit comments

Comments
 (0)