moving package comments into doc.go files (#534)

d2common/d2enum/doc.go

@@ -0,0 +1,3 @@
+// Package d2enum provides enumerations used throughout
+// the OpenDiablo2 codebase.
+package d2enum

d2common/d2fileformats/d2cof/cof.go

@@ -1,4 +1,3 @@
-// Package d2cof contains the logic for loading and processing COF files.
 package d2cof
 
 import (

d2common/d2fileformats/d2cof/doc.go

@@ -0,0 +1,2 @@
+// Package d2cof contains the logic for loading and processing COF files.
+package d2cof

d2common/d2fileformats/d2dat/dat.go

@@ -1,4 +1,3 @@
-// Package d2dat contains the logic for loading and processing DAT files.
 package d2dat
 
 // Load loads a DAT file.

d2common/d2fileformats/d2dat/doc.go

@@ -0,0 +1,2 @@
+// Package d2dat contains the logic for loading and processing DAT files.
+package d2dat

d2common/d2fileformats/d2dc6/dc6.go

@@ -1,4 +1,3 @@
-// Package d2dc6 contains the logic for loading and processing DC6 files.
 package d2dc6
 
 import (

d2common/d2fileformats/d2dc6/doc.go

@@ -0,0 +1,2 @@
+// Package d2dc6 contains the logic for loading and processing DC6 files.
+package d2dc6

d2common/d2fileformats/d2dcc/dcc.go

@@ -1,4 +1,3 @@
-// Package d2dcc contains the logic for loading and processing DCC files.
 package d2dcc
 
 import (

d2common/d2fileformats/d2dcc/doc.go

@@ -0,0 +1,2 @@
+// Package d2dcc contains the logic for loading and processing DCC files.
+package d2dcc

d2common/d2fileformats/d2ds1/doc.go

@@ -0,0 +1,2 @@
+// Package d2ds1 provides functionality for loading/processing DS1 files
+package d2ds1

d2common/d2fileformats/d2ds1/ds1.go

@@ -1,4 +1,3 @@
-// Package d2ds1 provides functionality for loading/processing DS1 files
 package d2ds1
 
 import (

d2common/d2fileformats/d2dt1/doc.go

@@ -0,0 +1,3 @@
+// Package d2dt1 provides functionality for loading/processing DT1 files.
+// https://d2mods.info/forum/viewtopic.php?t=65163
+package d2dt1

d2common/d2fileformats/d2dt1/dt1.go

@@ -1,5 +1,3 @@
-// Package d2dt1 provides functionality for loading/processing DT1 files.
-// https://d2mods.info/forum/viewtopic.php?t=65163
 package d2dt1
 
 import (

d2common/d2fileformats/d2mpq/doc.go

@@ -0,0 +1,2 @@
+// Package d2mpq contains the functions for handling MPQ files.
+package d2mpq

d2common/d2fileformats/d2mpq/mpq.go

@@ -1,4 +1,3 @@
-// Package d2mpq contains the functions for handling MPQ files.
 package d2mpq
 
 import (

d2common/d2fileformats/d2pl2/doc.go

@@ -0,0 +1,2 @@
+// Package d2pl2 handles processing of PL2 palette files.
+package d2pl2

d2common/d2fileformats/d2pl2/pl2.go

@@ -1,4 +1,3 @@
-// Package d2pl2 handles processing of PL2 palette files.
 package d2pl2
 
 import (

d2common/d2math/doc.go

@@ -0,0 +1,2 @@
+// Package d2math provides various math-related things
+package d2math

d2common/d2resource/doc.go

@@ -0,0 +1,2 @@
+// Package d2resource stores the paths of the resources inside the mpq files.
+package d2resource

d2common/d2resource/resource_paths.go

@@ -1,4 +1,3 @@
-// Package d2resource stores the paths of the resources inside the mpq files.
 package d2resource
 
 var LanguageCode string

d2common/doc.go

@@ -0,0 +1,3 @@
+// Package d2common provides common stuff for all of the other
+// high-level packages in the codebase
+package d2common

d2core/d2asset/d2asset.go

@@ -1,6 +1,3 @@
-/*
-Package d2asset has behaviors to load and save assets from disk.
-*/
 package d2asset
 
 import (

d2core/d2asset/doc.go

@@ -0,0 +1,2 @@
+// Package d2asset has behaviors to load and save assets from disk.
+package d2asset

d2core/d2config/config.go

@@ -1,4 +1,3 @@
-// Package d2config contains configuration objects and functions
 package d2config
 
 import (

d2core/d2config/doc.go

@@ -0,0 +1,2 @@
+// Package d2config contains configuration management for OpenDiablo2
+package d2config

d2core/d2gui/doc.go

@@ -0,0 +1,2 @@
+// Package d2gui provides higher-level ui component management
+package d2gui

d2core/d2hero/doc.go

@@ -0,0 +1,2 @@
+// Package d2hero utilities for managing a hero state.
+package d2hero

d2core/d2hero/hero_stats_state.go

@@ -1,4 +1,3 @@
-// Package d2hero utilities for managing a hero state.
 package d2hero
 
 import (

d2core/d2input/doc.go

@@ -0,0 +1,2 @@
+// Package d2input provides an input manager
+package d2input

d2core/d2inventory/doc.go

@@ -0,0 +1,2 @@
+// Package d2inventory provides repreentations of player inventory
+package d2inventory

d2core/d2map/d2mapengine/doc.go

@@ -0,0 +1,3 @@
+// Package d2mapengine provides a map engine, something that
+// can place diablo tile data onto a plane.
+package d2mapengine

d2core/d2map/d2mapentity/doc.go

@@ -0,0 +1,2 @@
+// Package d2mapentity provides representations of map entities
+package d2mapentity

d2core/d2map/d2mapgen/doc.go

@@ -0,0 +1,3 @@
+// Package d2mapgen provides map generator implementations
+// for use with the map engine
+package d2mapgen

d2core/d2map/d2maprenderer/doc.go

@@ -0,0 +1,2 @@
+// Package d2maprenderer provides a renderer for the map engine
+package d2maprenderer

d2core/d2map/d2mapstamp/doc.go

@@ -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

d2core/d2screen/d2screen.go

@@ -1,4 +1,3 @@
-// Package d2screen contains the interface for screens
 package d2screen
 
 import (

d2core/d2screen/doc.go

@@ -0,0 +1,3 @@
+// Package d2screen provides a means of defining and
+// transitioning between game screens
+package d2screen

d2core/d2term/doc.go

@@ -0,0 +1,3 @@
+// Package d2term provides a in-game terminal that allows
+// executing custom commands for debugging
+package d2term

d2core/d2term/terminal.go

@@ -1,4 +1,3 @@
-// Package d2term provides a in-game terminal that allows executing custom commands for debugging
 package d2term
 
 import (

d2core/d2ui/doc.go

@@ -0,0 +1,3 @@
+// Package d2ui provides ui elements like buttons, scrollbars,
+// checkboxes, text labels, etc.
+package d2ui

d2game/d2gamescreen/doc.go

@@ -0,0 +1,2 @@
+// Package d2gamescreen is where the game screens are defined
+package d2gamescreen

d2game/d2player/doc.go

@@ -0,0 +1,2 @@
+// Package d2player contains the information necessary for managing players
+package d2player

d2game/d2player/equipment_slot.go

@@ -1,4 +1,3 @@
-// Package d2player contains the information necessary for managing players
 package d2player
 
 import "github.com/OpenDiablo2/OpenDiablo2/d2common/d2enum"

d2networking/d2client/d2clientconnectiontype/doc.go

@@ -0,0 +1,3 @@
+// Package d2clientconnectiontype provides types
+// for client connections
+package d2clientconnectiontype

d2networking/d2client/d2localclient/doc.go

@@ -0,0 +1,2 @@
+// Package d2localclient facilitates communication between a local client and server.
+package d2localclient

d2networking/d2client/d2localclient/local_client_connection.go

@@ -1,4 +1,3 @@
-// Package d2localclient facilitates communication between a local client and server.
 package d2localclient
 
 import (

d2networking/d2client/d2remoteclient/doc.go

@@ -0,0 +1,2 @@
+// Package d2remoteclient facilitates communication between a remote client and server.
+package d2remoteclient

d2networking/d2client/d2remoteclient/remote_client_connection.go

@@ -1,4 +1,3 @@
-// Package d2remoteclient facilitates communication between a remote client and server.
 package d2remoteclient
 
 import (

d2networking/d2netpacket/d2netpackettype/doc.go

@@ -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

d2networking/d2netpacket/net_packet.go

@@ -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
 
 import "github.com/OpenDiablo2/OpenDiablo2/d2networking/d2netpacket/d2netpackettype"

d2script/doc.go

@@ -0,0 +1,3 @@
+// Package d2script provides a virtual machine for
+// interpretting scripts
+package d2script