diff options
| author | Paolo Bonzini <pbonzini@redhat.com> | 2025-01-30 11:11:18 +0100 |
|---|---|---|
| committer | Paolo Bonzini <pbonzini@redhat.com> | 2025-02-13 12:51:34 +0100 |
| commit | ebacd14a6f97b6235e078d9a9ac8a342a3be7c96 (patch) | |
| tree | 26c4cb41da6b4543686235ed2f8ed1395e8f6abc /rust/qemu-api/src/offset_of.rs | |
| parent | d128c341a744ba3e92fa67d9f1b02dd9a7bd68b9 (diff) | |
| download | qemu-ebacd14a6f97b6235e078d9a9ac8a342a3be7c96.zip qemu-ebacd14a6f97b6235e078d9a9ac8a342a3be7c96.tar.gz qemu-ebacd14a6f97b6235e078d9a9ac8a342a3be7c96.tar.bz2 | |
rust: qemu_api: add a documentation header for all modules
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'rust/qemu-api/src/offset_of.rs')
| -rw-r--r-- | rust/qemu-api/src/offset_of.rs | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/rust/qemu-api/src/offset_of.rs b/rust/qemu-api/src/offset_of.rs index 075e98f..373229b 100644 --- a/rust/qemu-api/src/offset_of.rs +++ b/rust/qemu-api/src/offset_of.rs @@ -1,5 +1,12 @@ // SPDX-License-Identifier: MIT +#![doc(hidden)] +//! This module provides macros that emulate the functionality of +//! `core::mem::offset_of` on older versions of Rust. +//! +//! Documentation is hidden because it only exposes macros, which +//! are exported directly from `qemu_api`. + /// This macro provides the same functionality as `core::mem::offset_of`, /// except that only one level of field access is supported. The declaration /// of the struct must be wrapped with `with_offsets! { }`. |