mirror of
https://github.com/Mezeporta/Erupe.git
synced 2026-03-22 07:32:32 +01:00
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:
@@ -135,6 +135,7 @@ func (b *ByteFrame) DataFromCurrent() []byte {
|
||||
return b.buf[b.index:b.usedSize]
|
||||
}
|
||||
|
||||
// Index returns the current read/write position in the buffer.
|
||||
func (b *ByteFrame) Index() uint {
|
||||
return b.index
|
||||
}
|
||||
|
||||
4
common/byteframe/doc.go
Normal file
4
common/byteframe/doc.go
Normal file
@@ -0,0 +1,4 @@
|
||||
// Package byteframe provides a seekable, growable byte buffer for reading and
|
||||
// writing binary data in big-endian or little-endian byte order. It is the
|
||||
// primary serialization primitive used throughout the Erupe network layer.
|
||||
package byteframe
|
||||
Reference in New Issue
Block a user