zig

commit 00acf8a66dec78743d26d62e86391b8794a1c627 (tree)
parent 50e2a5f673d880515caf3497bfb6eb0114149de1
Author: Andrew Kelley <andrew@ziglang.org>
Date:   Sun, 11 Feb 2024 22:20:55 -0700

std.http.Server: remove source code from doc comments

Documentation comments are not an appropriate place to put code samples.

Diffstat:
M
lib/std/http/Server.zig
 | 
37
-------------------------------------

1 file changed, 0 insertions(+), 37 deletions(-)
diff --git a/lib/std/http/Server.zig b/lib/std/http/Server.zig
@@ -2,43 +2,6 @@
 //!
 //! This server assumes clients are well behaved and standard compliant; it
 //! deadlocks if a client holds a connection open without sending a request.
-//!
-//! Example usage:
-//!
-//! ```zig
-//! var server = Server.init(.{ .reuse_address = true });
-//! defer server.deinit();
-//!
-//! try server.listen(bind_addr);
-//!
-//! while (true) {
-//!     var res = try server.accept(.{ .allocator = gpa });
-//!     defer res.deinit();
-//!
-//!     while (res.reset() != .closing) {
-//!         res.wait() catch |err| switch (err) {
-//!             error.HttpHeadersInvalid => break,
-//!             error.HttpHeadersOversize => {
-//!                 res.status = .request_header_fields_too_large;
-//!                 res.send() catch break;
-//!                 break;
-//!             },
-//!             else => {
-//!                 res.status = .bad_request;
-//!                 res.send() catch break;
-//!                 break;
-//!             },
-//!         }
-//!
-//!         res.status = .ok;
-//!         res.transfer_encoding = .chunked;
-//!
-//!         try res.send();
-//!         try res.writeAll("Hello, World!\n");
-//!         try res.finish();
-//!     }
-//! }
-//! ```
 
 const builtin = @import("builtin");
 const std = @import("../std.zig");