added some missting doc files

hardware/memory/cartridge/harmony/doc.go

@@ -0,0 +1,18 @@
+// This file is part of Gopher2600.
+//
+// Gopher2600 is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Gopher2600 is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Gopher2600.  If not, see <https://www.gnu.org/licenses/>.
+
+// Package harmony implements the Harmony cartridge. It is not yet fully
+// complete and in particular does not offer emulation of the ARM7 processor.
+package harmony

hardware/memory/cartridge/supercharger/doc.go

@@ -0,0 +1,39 @@
+// This file is part of Gopher2600.
+//
+// Gopher2600 is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Gopher2600 is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Gopher2600.  If not, see <https://www.gnu.org/licenses/>.
+//
+// *** NOTE: all historical versions of this file, as found in any
+// git repository, are also covered by the licence, even when this
+// notice is not present ***
+
+// Package supercharger implements the tape based cartridge format. The
+// implementation is complex enough for it to be spread over more than one file
+// and so for purposes of clarity it has been placed in its own package.
+//
+// The supercharger is interfaced in the same way as other cartridge formats.
+// The fastload mechanism however, requires special handling, which is
+// unfortunate but unavoidable. It is worth summarising here:
+//
+// As a result of a fast-load of a BIN file into supercharger memory, the
+// supercharger package will return an error of type supercharger.FastLoaded
+//
+// The FastLoaded error indicates an exception to the normal running of the
+// emulation. For the loading to complete the error needs special handling.
+// There are two places in Gopher2600 where this handling takes place. One is
+// in the debugger.inputLoop() and the other in hardware.run() (the latter is
+// called from the playmode package).
+//
+// Wherever it is handled, the error should be caught and interpreted as a
+// function and called, with a reference to the emulator's CPU, RAM and Timer.
+package supercharger

hardware/memory/cartridge/supercharger/fastload.go

@@ -34,10 +34,11 @@ import (
 // On success it returns the FastLoaded error. This must be interpreted by the
 // emulator driver and called with the arguments listed in the error type.
 //
-// Format information from mailing list:
-//		Subject: Re: [stella] Supercharger BIN format
-//		From: Eckhard Stolberg
-//		Date: Fri, 08 Jan 1999
+// Format information for fast-loca binary rom mailing list post:
+//
+// Subject: Re: [stella] Supercharger BIN format
+// From: Eckhard Stolberg
+// Date: Fri, 08 Jan 1999
 type FastLoad struct {
 	cart *Supercharger
 	data []byte

test/doc.go

@@ -46,4 +46,11 @@
 // the main thread or from a non-main thread. These functions do nothing unless
 // the "assertions" build tag is specified at compile time.
 
+// Package test bundles a bunch of useful functions useful for testing
+// purposes, particular useful in conjunction with the standard go test harness
+//
+// The AssertMainThread() and AssertNonMainThread() functions require a bit of
+// explanation. When compiled with the "assertions" tag these functions will
+// panic if the calling function is in the wrong thread. Otherwise they are
+// stubbed.
 package test