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/assertions.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/assertions.rs')
-rw-r--r-- | rust/qemu-api/src/assertions.rs | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/rust/qemu-api/src/assertions.rs b/rust/qemu-api/src/assertions.rs index 6e42046..fa1a18d 100644 --- a/rust/qemu-api/src/assertions.rs +++ b/rust/qemu-api/src/assertions.rs @@ -2,9 +2,13 @@ // Author(s): Paolo Bonzini <pbonzini@redhat.com> // SPDX-License-Identifier: GPL-2.0-or-later +#![doc(hidden)] //! This module provides macros to check the equality of types and //! the type of `struct` fields. This can be useful to ensure that //! types match the expectations of C code. +//! +//! Documentation is hidden because it only exposes macros, which +//! are exported directly from `qemu_api`. // Based on https://stackoverflow.com/questions/64251852/x/70978292#70978292 // (stackoverflow answers are released under MIT license). |