moving package comments into doc.go files (#534)
This commit is contained in:
parent
18003a8543
commit
de116e8367
|
@ -0,0 +1,3 @@
|
||||||
|
// Package d2enum provides enumerations used throughout
|
||||||
|
// the OpenDiablo2 codebase.
|
||||||
|
package d2enum
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2cof contains the logic for loading and processing COF files.
|
|
||||||
package d2cof
|
package d2cof
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2cof contains the logic for loading and processing COF files.
|
||||||
|
package d2cof
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2dat contains the logic for loading and processing DAT files.
|
|
||||||
package d2dat
|
package d2dat
|
||||||
|
|
||||||
// Load loads a DAT file.
|
// Load loads a DAT file.
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2dat contains the logic for loading and processing DAT files.
|
||||||
|
package d2dat
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2dc6 contains the logic for loading and processing DC6 files.
|
|
||||||
package d2dc6
|
package d2dc6
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2dc6 contains the logic for loading and processing DC6 files.
|
||||||
|
package d2dc6
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2dcc contains the logic for loading and processing DCC files.
|
|
||||||
package d2dcc
|
package d2dcc
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2dcc contains the logic for loading and processing DCC files.
|
||||||
|
package d2dcc
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2ds1 provides functionality for loading/processing DS1 files
|
||||||
|
package d2ds1
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2ds1 provides functionality for loading/processing DS1 files
|
|
||||||
package d2ds1
|
package d2ds1
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,3 @@
|
||||||
|
// Package d2dt1 provides functionality for loading/processing DT1 files.
|
||||||
|
// https://d2mods.info/forum/viewtopic.php?t=65163
|
||||||
|
package d2dt1
|
|
@ -1,5 +1,3 @@
|
||||||
// Package d2dt1 provides functionality for loading/processing DT1 files.
|
|
||||||
// https://d2mods.info/forum/viewtopic.php?t=65163
|
|
||||||
package d2dt1
|
package d2dt1
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2mpq contains the functions for handling MPQ files.
|
||||||
|
package d2mpq
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2mpq contains the functions for handling MPQ files.
|
|
||||||
package d2mpq
|
package d2mpq
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2pl2 handles processing of PL2 palette files.
|
||||||
|
package d2pl2
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2pl2 handles processing of PL2 palette files.
|
|
||||||
package d2pl2
|
package d2pl2
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2math provides various math-related things
|
||||||
|
package d2math
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2resource stores the paths of the resources inside the mpq files.
|
||||||
|
package d2resource
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2resource stores the paths of the resources inside the mpq files.
|
|
||||||
package d2resource
|
package d2resource
|
||||||
|
|
||||||
var LanguageCode string
|
var LanguageCode string
|
||||||
|
|
|
@ -0,0 +1,3 @@
|
||||||
|
// Package d2common provides common stuff for all of the other
|
||||||
|
// high-level packages in the codebase
|
||||||
|
package d2common
|
|
@ -1,6 +1,3 @@
|
||||||
/*
|
|
||||||
Package d2asset has behaviors to load and save assets from disk.
|
|
||||||
*/
|
|
||||||
package d2asset
|
package d2asset
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2asset has behaviors to load and save assets from disk.
|
||||||
|
package d2asset
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2config contains configuration objects and functions
|
|
||||||
package d2config
|
package d2config
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2config contains configuration management for OpenDiablo2
|
||||||
|
package d2config
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2gui provides higher-level ui component management
|
||||||
|
package d2gui
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2hero utilities for managing a hero state.
|
||||||
|
package d2hero
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2hero utilities for managing a hero state.
|
|
||||||
package d2hero
|
package d2hero
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2input provides an input manager
|
||||||
|
package d2input
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2inventory provides repreentations of player inventory
|
||||||
|
package d2inventory
|
|
@ -0,0 +1,3 @@
|
||||||
|
// Package d2mapengine provides a map engine, something that
|
||||||
|
// can place diablo tile data onto a plane.
|
||||||
|
package d2mapengine
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2mapentity provides representations of map entities
|
||||||
|
package d2mapentity
|
|
@ -0,0 +1,3 @@
|
||||||
|
// Package d2mapgen provides map generator implementations
|
||||||
|
// for use with the map engine
|
||||||
|
package d2mapgen
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2maprenderer provides a renderer for the map engine
|
||||||
|
package d2maprenderer
|
|
@ -0,0 +1,3 @@
|
||||||
|
// Package d2mapstamp provides a representation of a preset map
|
||||||
|
// which can be used "like a stamp" by the map engine
|
||||||
|
package d2mapstamp
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2screen contains the interface for screens
|
|
||||||
package d2screen
|
package d2screen
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,3 @@
|
||||||
|
// Package d2screen provides a means of defining and
|
||||||
|
// transitioning between game screens
|
||||||
|
package d2screen
|
|
@ -0,0 +1,3 @@
|
||||||
|
// Package d2term provides a in-game terminal that allows
|
||||||
|
// executing custom commands for debugging
|
||||||
|
package d2term
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2term provides a in-game terminal that allows executing custom commands for debugging
|
|
||||||
package d2term
|
package d2term
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,3 @@
|
||||||
|
// Package d2ui provides ui elements like buttons, scrollbars,
|
||||||
|
// checkboxes, text labels, etc.
|
||||||
|
package d2ui
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2gamescreen is where the game screens are defined
|
||||||
|
package d2gamescreen
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2player contains the information necessary for managing players
|
||||||
|
package d2player
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2player contains the information necessary for managing players
|
|
||||||
package d2player
|
package d2player
|
||||||
|
|
||||||
import "github.com/OpenDiablo2/OpenDiablo2/d2common/d2enum"
|
import "github.com/OpenDiablo2/OpenDiablo2/d2common/d2enum"
|
||||||
|
|
|
@ -0,0 +1,3 @@
|
||||||
|
// Package d2clientconnectiontype provides types
|
||||||
|
// for client connections
|
||||||
|
package d2clientconnectiontype
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2localclient facilitates communication between a local client and server.
|
||||||
|
package d2localclient
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2localclient facilitates communication between a local client and server.
|
|
||||||
package d2localclient
|
package d2localclient
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
// Package d2remoteclient facilitates communication between a remote client and server.
|
||||||
|
package d2remoteclient
|
|
@ -1,4 +1,3 @@
|
||||||
// Package d2remoteclient facilitates communication between a remote client and server.
|
|
||||||
package d2remoteclient
|
package d2remoteclient
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -0,0 +1,11 @@
|
||||||
|
// Package d2netpackettype defines types which are encoded to JSON and sent in network
|
||||||
|
// packet payloads.
|
||||||
|
// Package d2netpacket/d2netpackettype defines a uint32 enumerable representing each
|
||||||
|
// packet type.
|
||||||
|
//
|
||||||
|
// A struct is defined for each packet type. Each struct comes with a function which
|
||||||
|
// returns a NetPacket declaring the type enum (header) followed by the associated
|
||||||
|
// struct (body). The NetPacket is marshaled to JSON for transport. On receipt of
|
||||||
|
// the packet, the enum is read as a single byte then the remaining data (the struct)
|
||||||
|
// is unmarshalled to the type associated with the type enum.
|
||||||
|
package d2netpackettype
|
|
@ -1,14 +1,3 @@
|
||||||
// Package d2netpacket defines types which are encoded to JSON and sent in network
|
|
||||||
// packet payloads.
|
|
||||||
/*
|
|
||||||
Package d2netpacket/d2netpackettype defines a uint32 enumerable representing each
|
|
||||||
packet type.
|
|
||||||
|
|
||||||
A struct is defined for each packet type. Each struct comes with a function which
|
|
||||||
returns a NetPacket declaring the type enum (header) followed by the associated
|
|
||||||
struct (body). The NetPacket is marshalled to JSON for transport. On receipt of
|
|
||||||
the packet, the enum is read as a single byte then the remaining data (the struct)
|
|
||||||
is unmarshalled to the type associated with the type enum.*/
|
|
||||||
package d2netpacket
|
package d2netpacket
|
||||||
|
|
||||||
import "github.com/OpenDiablo2/OpenDiablo2/d2networking/d2netpacket/d2netpackettype"
|
import "github.com/OpenDiablo2/OpenDiablo2/d2networking/d2netpacket/d2netpackettype"
|
||||||
|
|
|
@ -0,0 +1,3 @@
|
||||||
|
// Package d2script provides a virtual machine for
|
||||||
|
// interpretting scripts
|
||||||
|
package d2script
|
Loading…
Reference in New Issue