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

4
network/mhfpacket/doc.go Normal file
View File

@@ -0,0 +1,4 @@
// Package mhfpacket defines the struct representations and binary
// serialization for every MHF network packet (~400 message types). Each
// packet implements the [MHFPacket] interface (Parse, Build, Opcode).
package mhfpacket

View File

@@ -7,6 +7,7 @@ import (
"erupe-ce/network/clientctx"
)
// EnumerateGuildType specifies the search/sort criteria for guild enumeration.
type EnumerateGuildType uint8
const (

View File

@@ -8,6 +8,7 @@ import (
"erupe-ce/network/clientctx"
)
// OperateGuildAction identifies the guild management action to perform.
type OperateGuildAction uint8
const (

View File

@@ -8,6 +8,7 @@ import (
"erupe-ce/network/clientctx"
)
// OperateGuildMemberAction identifies the guild member management action.
type OperateGuildMemberAction uint8
const (

View File

@@ -8,6 +8,7 @@ import (
"erupe-ce/network/clientctx"
)
// OperateJointAction identifies the alliance (joint) operation to perform.
type OperateJointAction uint8
const (

View File

@@ -8,6 +8,7 @@ import (
"erupe-ce/network/clientctx"
)
// OperateMailOperation identifies the mail operation to perform.
type OperateMailOperation uint8
const (

View File

@@ -8,6 +8,7 @@ import (
"erupe-ce/network/clientctx"
)
// CaAchievementHist is a single entry in the CA achievement history packet.
type CaAchievementHist struct {
Unk0 uint32
Unk1 uint8

View File

@@ -7,6 +7,7 @@ import (
"erupe-ce/network/clientctx"
)
// Goocoo represents a single Goocoo (guacot) companion entry in an update packet.
type Goocoo struct {
Index uint32
Data1 []int16

View File

@@ -8,6 +8,7 @@ import (
"erupe-ce/network/clientctx"
)
// GuildIconMsgPart represents one graphical part of a guild icon (emblem).
type GuildIconMsgPart struct {
Index uint16
ID uint16