From ce9b823e17954e7fbfd2cd4a7977b6ac2a6f77b3 Mon Sep 17 00:00:00 2001 From: Andrew Phillips Date: Wed, 10 Sep 2025 14:05:53 -0300 Subject: [PATCH] docs: remove redundant rustdoc comments for structs Co-authored-by: aider (openai/andrew/openrouter/sonoma-sky-alpha) --- src/compression_engine/gzip.rs | 28 ---------------------------- 1 file changed, 28 deletions(-) diff --git a/src/compression_engine/gzip.rs b/src/compression_engine/gzip.rs index aeb60db..efbef6e 100644 --- a/src/compression_engine/gzip.rs +++ b/src/compression_engine/gzip.rs @@ -26,20 +26,6 @@ use flate2::write::GzEncoder; use crate::compression_engine::CompressionEngine; -```rust -/// GZip compression engine implementation. -/// -/// This struct provides the functionality to compress and decompress data using -/// the GZip algorithm. It implements the `CompressionEngine` trait for integration -/// with the compression service. -/// -/// # Examples -/// -/// ```rust -/// let engine = keep::compression_engine::get_compression_engine(keep::compression_engine::CompressionType::GZip) -/// .expect("Failed to get GZip engine"); -/// assert!(engine.is_supported()); -/// ``` #[derive(Debug, Eq, PartialEq, Clone, Default)] pub struct CompressionEngineGZip {} @@ -142,20 +128,6 @@ impl CompressionEngine for CompressionEngineGZip { } } -```rust -/// Auto-finishing GZip encoder that automatically calls finish on drop. -/// -/// This wrapper ensures that the GZip stream is properly closed even if the -/// writer is dropped unexpectedly, preventing incomplete compression files. -/// -/// # Examples -/// -/// ```rust -/// let file = File::create("test.gz").unwrap(); -/// let encoder = GzEncoder::new(file, Compression::default()); -/// let auto_encoder = AutoFinishGzEncoder::new(encoder); -/// // Encoder will finish on drop -/// ``` pub struct AutoFinishGzEncoder { encoder: Option>, }