From 4239043ef85d5e0bb103659f7c0831d9426af498 Mon Sep 17 00:00:00 2001 From: Kenny Kerr Date: Mon, 26 Aug 2024 09:51:20 -0500 Subject: [PATCH] Address Clippy warning about long first doc paragraph (#3222) --- crates/libs/core/src/inspectable.rs | 2 ++ crates/libs/core/src/unknown.rs | 2 ++ crates/libs/metadata/src/lib.rs | 6 +++--- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/crates/libs/core/src/inspectable.rs b/crates/libs/core/src/inspectable.rs index a84305ba8e..eb53dedad6 100644 --- a/crates/libs/core/src/inspectable.rs +++ b/crates/libs/core/src/inspectable.rs @@ -2,6 +2,8 @@ use super::*; use core::ffi::c_void; use core::ptr::null_mut; +/// Parent interface for all WinRT interfaces. +/// /// A WinRT object that may be used as a polymorphic stand-in for any WinRT class, interface, or boxed value. /// [`IInspectable`] represents the /// [IInspectable](https://docs.microsoft.com/en-us/windows/win32/api/inspectable/nn-inspectable-iinspectable) diff --git a/crates/libs/core/src/unknown.rs b/crates/libs/core/src/unknown.rs index bdbaf84bc6..10598628ff 100644 --- a/crates/libs/core/src/unknown.rs +++ b/crates/libs/core/src/unknown.rs @@ -2,6 +2,8 @@ use super::*; use core::ffi::c_void; use core::ptr::NonNull; +/// Base interface for all COM interfaces. +/// /// All COM interfaces (and thus WinRT classes and interfaces) implement /// [IUnknown](https://docs.microsoft.com/en-us/windows/win32/api/unknwn/nn-unknwn-iunknown) /// under the hood to provide reference-counted lifetime management as well as the ability diff --git a/crates/libs/metadata/src/lib.rs b/crates/libs/metadata/src/lib.rs index 01ddd4728d..618fec534a 100644 --- a/crates/libs/metadata/src/lib.rs +++ b/crates/libs/metadata/src/lib.rs @@ -47,9 +47,9 @@ pub struct METADATA_HEADER { pub const METADATA_SIGNATURE: u32 = 0x424A_5342; -/// A coded index (see codes.rs) is a table index that may refer to different tables. The size of the column in memory -/// must therefore be large enough to hold an index for a row in the largest possible table. This function determines -/// this size for the given winmd file. +// A coded index (see codes.rs) is a table index that may refer to different tables. The size of the column in memory +// must therefore be large enough to hold an index for a row in the largest possible table. This function determines +// this size for the given winmd file. pub fn coded_index_size(tables: &[usize]) -> usize { fn small(row_count: usize, bits: u8) -> bool { (row_count as u64) < (1u64 << (16 - bits))