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/c_str.rs | |
| parent | d128c341a744ba3e92fa67d9f1b02dd9a7bd68b9 (diff) | |
| download | focaccia-qemu-ebacd14a6f97b6235e078d9a9ac8a342a3be7c96.tar.gz focaccia-qemu-ebacd14a6f97b6235e078d9a9ac8a342a3be7c96.zip | |
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/c_str.rs')
| -rw-r--r-- | rust/qemu-api/src/c_str.rs | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/rust/qemu-api/src/c_str.rs b/rust/qemu-api/src/c_str.rs index 4cd96da0b4..3fa61b59c7 100644 --- a/rust/qemu-api/src/c_str.rs +++ b/rust/qemu-api/src/c_str.rs @@ -2,6 +2,14 @@ // Author(s): Paolo Bonzini <pbonzini@redhat.com> // SPDX-License-Identifier: GPL-2.0-or-later +#![doc(hidden)] +//! This module provides a macro to define a constant of type +//! [`CStr`](std::ffi::CStr), for compatibility with versions of +//! Rust that lack `c""` literals. +//! +//! Documentation is hidden because it only exposes macros, which +//! are exported directly from `qemu_api`. + #[macro_export] /// Given a string constant _without_ embedded or trailing NULs, return /// a `CStr`. |