Mirror/Erupe
1
0
Fork 0
mirror of https://github.com/Mezeporta/Erupe.git synced 2026-03-22 07:32:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

16
common/stringsupport/string_convert.go
View File

@@ -11,6 +11,8 @@ import (
"golang.org/x/text/transform"
)
// UTF8ToSJIS encodes a UTF-8 string to Shift-JIS bytes, silently dropping any
// runes that cannot be represented in Shift-JIS.
func UTF8ToSJIS(x string) []byte {
e := japanese.ShiftJIS.NewEncoder()
xt, _, err := transform.String(e, x)
@@ -28,6 +30,7 @@ func UTF8ToSJIS(x string) []byte {
return []byte(xt)
}
// SJISToUTF8 decodes Shift-JIS bytes to a UTF-8 string.
func SJISToUTF8(b []byte) string {
d := japanese.ShiftJIS.NewDecoder()
result, err := io.ReadAll(transform.NewReader(bytes.NewReader(b), d))
@@ -37,6 +40,8 @@ func SJISToUTF8(b []byte) string {
return string(result)
}
// ToNGWord converts a UTF-8 string into a slice of uint16 values in the
// Shift-JIS byte-swapped format used by the MHF NG-word (chat filter) system.
func ToNGWord(x string) []uint16 {
var w []uint16
for _, r := range x {
@@ -55,6 +60,8 @@ func ToNGWord(x string) []uint16 {
return w
}
// PaddedString returns a fixed-width null-terminated byte slice of the given
// size. If t is true the string is first encoded to Shift-JIS.
func PaddedString(x string, size uint, t bool) []byte {
if t {
e := japanese.ShiftJIS.NewEncoder()
@@ -70,6 +77,7 @@ func PaddedString(x string, size uint, t bool) []byte {
return out
}
// CSVAdd appends v to the comma-separated integer list if not already present.
func CSVAdd(csv string, v int) string {
if len(csv) == 0 {
return strconv.Itoa(v)
@@ -81,6 +89,7 @@ func CSVAdd(csv string, v int) string {
}
}
// CSVRemove removes v from the comma-separated integer list.
func CSVRemove(csv string, v int) string {
s := strings.Split(csv, ",")
for i, e := range s {
@@ -92,6 +101,7 @@ func CSVRemove(csv string, v int) string {
return strings.Join(s, ",")
}
// CSVContains reports whether v is present in the comma-separated integer list.
func CSVContains(csv string, v int) bool {
s := strings.Split(csv, ",")
for i := 0; i < len(s); i++ {
@@ -103,6 +113,7 @@ func CSVContains(csv string, v int) bool {
return false
}
// CSVLength returns the number of elements in the comma-separated list.
func CSVLength(csv string) int {
if csv == "" {
return 0
@@ -111,6 +122,7 @@ func CSVLength(csv string) int {
return len(s)
}
// CSVElems parses the comma-separated integer list into an int slice.
func CSVElems(csv string) []int {
var r []int
if csv == "" {
@@ -124,6 +136,8 @@ func CSVElems(csv string) []int {
return r
}
// CSVGetIndex returns the integer at position i in the comma-separated list,
// or 0 if i is out of range.
func CSVGetIndex(csv string, i int) int {
s := CSVElems(csv)
if i < len(s) {
@@ -132,6 +146,8 @@ func CSVGetIndex(csv string, i int) int {
return 0
}
// CSVSetIndex replaces the integer at position i in the comma-separated list
// with v. If i is out of range the list is returned unchanged.
func CSVSetIndex(csv string, i int, v int) string {
s := CSVElems(csv)
if i < len(s) {