From a3ad0a2f771e2c6b4b71d694ff4ea8fc1aa26479 Mon Sep 17 00:00:00 2001 From: Shun Sakai Date: Wed, 22 Jan 2025 23:34:57 +0900 Subject: [PATCH] std.compress.flate.Lookup: Replace invisible doc comments with top-level doc comments I think it would be better if this invisible doc comments is top-level doc comments rather than doc comments. Because it is at the start of a source file. This makes the doc comments visible. --- lib/std/compress/flate/Lookup.zig | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/std/compress/flate/Lookup.zig b/lib/std/compress/flate/Lookup.zig index c646b2dd28..90d0341bca 100644 --- a/lib/std/compress/flate/Lookup.zig +++ b/lib/std/compress/flate/Lookup.zig @@ -1,7 +1,7 @@ -/// Lookup of the previous locations for the same 4 byte data. Works on hash of -/// 4 bytes data. Head contains position of the first match for each hash. Chain -/// points to the previous position of the same hash given the current location. -/// +//! Lookup of the previous locations for the same 4 byte data. Works on hash of +//! 4 bytes data. Head contains position of the first match for each hash. Chain +//! points to the previous position of the same hash given the current location. + const std = @import("std"); const testing = std.testing; const expect = testing.expect;