std.zip: 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.

However, the last paragraph replaces doc comments with normal comments.
This is because I thought that normal comments would be more
appropriate than top-level doc comments given the context of the last
paragraph.
This commit is contained in:
Shun Sakai 2025-01-22 23:37:04 +09:00
parent a3ad0a2f77
commit 30fc1012ae

View File

@ -1,8 +1,8 @@
/// The .ZIP File Format Specification is found here:
/// https://pkwaredownloads.blob.core.windows.net/pem/APPNOTE.txt
///
/// Note that this file uses the abbreviation "cd" for "central directory"
///
//! The .ZIP File Format Specification is found here:
//! https://pkwaredownloads.blob.core.windows.net/pem/APPNOTE.txt
// Note that this file uses the abbreviation "cd" for "central directory"
const builtin = @import("builtin");
const std = @import("std");
const testing = std.testing;