Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joshtynjala committed May 17, 2024
1 parent 841b083 commit 78516f4
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/snake/http/BaseHTTPRequestHandler.hx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ class BaseHTTPRequestHandler extends StreamRequestHandler {

/**
The version of the HTTP protocol we support.
set this to HTTP/1.1 to enable automatic keepalive
Set this to `"HTTP/1.1"` to enable automatic keepalive.
**/
public static var protocolVersion:String = "HTTP/1.0";

Expand Down
3 changes: 3 additions & 0 deletions src/snake/socket/BaseServer.hx
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ class BaseServer {

/**
Stops the `serveForever()` loop.
Blocks until the loop has finished. This must be called while
`serveForever()` is running in another thread, or it will deadlock.
**/
public function shutdown():Void {
__shutdownRequest = true;
Expand Down
2 changes: 1 addition & 1 deletion src/snake/socket/StreamRequestHandler.hx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import sys.net.Socket;
import haxe.io.Input;

/**
Define self.rfile and self.wfile for stream sockets.
Define `rfile` and `wfile` for stream sockets.
**/
class StreamRequestHandler extends BaseRequestHandler {
/**
Expand Down

0 comments on commit 78516f4

Please sign in to comment.