From b94000e63e9d8753249754f91027d315bdbe5ebe Mon Sep 17 00:00:00 2001 From: Kevin Chabowski Date: Sat, 21 Sep 2013 00:50:33 +0200 Subject: Added/improved some documentation. --- mcmap/chunk.go | 2 +- mcmap/examples/addchunk/main.go | 1 + mcmap/examples/delchunk/main.go | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) (limited to 'mcmap') diff --git a/mcmap/chunk.go b/mcmap/chunk.go index dfac5a7..1f7f5e1 100644 --- a/mcmap/chunk.go +++ b/mcmap/chunk.go @@ -127,7 +127,7 @@ func (c *Chunk) Biome(x, z int) Biome { return c.biomes[z*ChunkSizeXZ+x] } // SetBiome sets the biome at x,z. func (c *Chunk) SetBiome(x, z int, bio Biome) { c.biomes[z*ChunkSizeXZ+x] = bio } -// MarkUnused marks the chunk as unused. If all chunks of a superchunk are marked as unused, the superchunk will be unloaded and saved (if needed). +// MarkUnused marks the chunk as unused. If all chunks of a superchunk are marked as unused, the underlying superchunk will be unloaded and saved (if needed). // // You must not use the chunk any longer, after you called this function. // diff --git a/mcmap/examples/addchunk/main.go b/mcmap/examples/addchunk/main.go index c1920fd..5807d6e 100644 --- a/mcmap/examples/addchunk/main.go +++ b/mcmap/examples/addchunk/main.go @@ -1,3 +1,4 @@ +// addchunk adds a chunk at 200, 200 that consists of sandstone. package main import ( diff --git a/mcmap/examples/delchunk/main.go b/mcmap/examples/delchunk/main.go index c8996a5..e19aa9a 100644 --- a/mcmap/examples/delchunk/main.go +++ b/mcmap/examples/delchunk/main.go @@ -1,3 +1,4 @@ +// delchunk deletes the chunk at 200, 200 package main import ( -- cgit v1.2.3-70-g09d2