docs: add doc.go files and godoc comments to all packages

Add package-level documentation (doc.go) to all 22 first-party
packages and godoc comments to ~150 previously undocumented
exported symbols across common/, network/, and server/.
This commit is contained in:
Houmgaor
2026-02-18 21:39:13 +01:00
parent b9cb274ced
commit 2bd5f98f32
81 changed files with 342 additions and 0 deletions

View File

@@ -0,0 +1,12 @@
// Package entranceserver implements the MHF entrance server, which listens on
// TCP port 53310 and acts as the gateway between authentication (sign server)
// and gameplay (channel servers). It presents the server list to authenticated
// clients, handles character selection, and directs players to the appropriate
// channel server.
//
// The entrance server uses MHF's custom "binary8" encryption and "sum32"
// checksum for all client-server communication. Each client connection is
// short-lived: the server sends a single response containing the server list
// (SV2/SVR) and optionally user session data (USR), then closes the
// connection.
package entranceserver