Add documentation

System/ICCCStart.go

@@ -7,8 +7,15 @@ import (
 	LM "github.com/SommerEngineering/Ocean/Log/Meta"
 )
 
+// The receiver function for the ICCC message, that a server is up and running.
 func icccSystemStart(data map[string][]string) {
+
+	// Converts the HTTP form data into an object:
 	_, _, obj := ICCC.Data2Message(&SystemMessages.ICCCStartUpMessage{}, data)
+
+	// Cast the object to the right type:
 	messageData := obj.(*SystemMessages.ICCCStartUpMessage)
+
+	// Provide a log entry:
 	Log.LogShort(senderName, LM.CategorySYSTEM, LM.LevelINFO, LM.MessageNameSTARTUP, `ICCC message: The server is now up and ready.`, messageData.PublicIPAddressAndPort, messageData.AdminIPAddressAndPort)
 }

System/Init.go

@@ -13,18 +13,21 @@ import (
 	"strconv"
 )
 
+// Init the system.
 func initSystem() {
 
 	Log.LogShort(senderName, LM.CategorySYSTEM, LM.LevelINFO, LM.MessageNameSTARTUP, `The system is now starting.`)
 
-	// Set the desired amount of CPUs:
+	// Set the desired amount of CPUs to use by Ocean. Default: 2
 	utilizeCPUs := 2
 	if value, err := strconv.Atoi(ConfigurationDB.Read(`OceanUtilizeCPUs`)); err != nil {
+		// Case: Error! Use the default.
 		Log.LogFull(senderName, LM.CategorySYSTEM, LM.LevelERROR, LM.SeverityCritical, LM.ImpactUnknown, LM.MessageNameCONFIGURATION, `Was not able to read the OceanUtilizeCPUs configuration.`, `Use the default value instead.`)
 	} else {
 		utilizeCPUs = value
 	}
 
+	// Set the amount of CPUs:
 	runtime.GOMAXPROCS(utilizeCPUs)
 	Log.LogShort(senderName, LM.CategorySYSTEM, LM.LevelINFO, LM.MessageNameCONFIGURATION, `Configuration OceanUtilizeCPUs is set.`, fmt.Sprintf(`value=%d`, utilizeCPUs))
 

System/InitHandlers.go

@@ -14,25 +14,54 @@ import (
 	"github.com/SommerEngineering/Ocean/WebContent"
 )
 
+// Init the system and then the system's handlers.
 func InitHandlers() {
 
 	initSystem()
 	Log.LogShort(senderName, LM.CategorySYSTEM, LM.LevelINFO, LM.MessageNameSTARTUP, `Register now all system handlers.`)
 
+	//
 	// Public Handlers:
+	//
+
+	// Handler for the web frameworks like e.g. jQuery, Bootstrap, etc.
 	Handlers.AddPublicHandler(`/framework/`, WebContent.HandlerDeliverFramework)
+
+	// Handler for other static files:
 	Handlers.AddPublicHandler(`/staticFiles/`, StaticFiles.HandlerStaticFiles)
+
+	// Handler for the number generator:
 	Handlers.AddPublicHandler(`/next/number`, NumGen.HandlerGetNext)
+
+	// Handler for the robots.txt:
 	Handlers.AddPublicHandler(`/robots.txt`, Robots.HandlerRobots)
+
+	// Handler for the ICCC to the public:
 	Handlers.AddPublicHandler(`/ICCC`, ICCC.ICCCHandler)
 
+	//
 	// Private Handlers:
+	//
+
+	// Handler for the web frameworks like e.g. jQuery, Bootstrap, etc.
 	Handlers.AddAdminHandler(`/framework/`, WebContent.HandlerDeliverFramework)
+
+	// Handler for other static files:
 	Handlers.AddAdminHandler(`/staticFiles/`, StaticFiles.HandlerStaticFiles)
+
+	// Handler for the number generator:
 	Handlers.AddAdminHandler(`/next/number`, NumGen.HandlerGetNext)
+
+	// Handler for the ICCC to the private side:
 	Handlers.AddAdminHandler(`/ICCC`, ICCC.ICCCHandler)
+
+	// Handler for binary assets, used for the admin pages:
 	Handlers.AddAdminHandler(`/binaryAssets/`, BinaryAssets.HandlerBinaryAssets)
+
+	// Handler for the web logging:
 	Handlers.AddAdminHandler(`/log`, Web.HandlerWebLog)
+
+	// Handler for the web logging's CSS and JS:
 	Handlers.AddAdminHandler(`/log/css/normalize.css`, Web.HandlerCSSNormalize)
 	Handlers.AddAdminHandler(`/log/css/webflow.css`, Web.HandlerCSSWebflow)
 	Handlers.AddAdminHandler(`/log/css/log.css`, Web.HandlerCSSLog)
@@ -41,6 +70,7 @@ func InitHandlers() {
 	Handlers.AddAdminHandler(`/log/js/jquery.min.map`, Web.HandlerJSjQueryMap)
 	Handlers.AddAdminHandler(`/log/js/webflow.js`, Web.HandlerJSWebflow)
 
+	// Are the static files mapped to the public?
 	if ConfigurationDB.Read(`MapStaticFiles2Root`) == "true" {
 		Log.LogShort(senderName, LM.CategorySYSTEM, LM.LevelINFO, LM.MessageNameSTARTUP, `The static files are mapped to the root.`)
 		Handlers.AddPublicHandler(`/`, StaticFiles.HandlerMapStaticFiles2Root)

System/RegisterLoggingDevices.go

@@ -8,11 +8,13 @@ import (
 	LM "github.com/SommerEngineering/Ocean/Log/Meta"
 )
 
+// Init the logging devices.
 func initLoggingDevices() {
 
 	Log.LogShort(senderName, LM.CategorySYSTEM, LM.LevelINFO, LM.MessageNameINIT, `Init the logging devices.`)
 	defer Log.LogShort(senderName, LM.CategorySYSTEM, LM.LevelINFO, LM.MessageNameINIT, `Init the logging devices done.`)
 
+	// Is the database logger enabled?
 	if ConfigurationDB.Read(`LogUseDatabaseLogging`) == `true` {
 		Log.LogShort(senderName, LM.CategorySYSTEM, LM.LevelINFO, LM.MessageNameCONFIGURATION, `The database logger is active.`)
 		activateDatabaseLogger()
@@ -20,6 +22,7 @@ func initLoggingDevices() {
 		Log.LogShort(senderName, LM.CategorySYSTEM, LM.LevelINFO, LM.MessageNameCONFIGURATION, `The database logger is NOT active.`)
 	}
 
+	// Is the console logger enabled?
 	if ConfigurationDB.Read(`LogUseConsoleLogging`) == `true` {
 		Log.LogShort(senderName, LM.CategorySYSTEM, LM.LevelINFO, LM.MessageNameCONFIGURATION, `The console logger is active.`)
 		activateConsoleLogger()

System/Start.go

@@ -5,8 +5,13 @@ import (
 	"time"
 )
 
+// The main function for the application.
 func StartAndBlockForever() {
+
+	// Starts the public and private web server with own threads:
 	WebServer.Start()
+
+	// Wait forever:
 	for {
 		time.Sleep(1 * time.Second)
 	}

System/Variables.go

@@ -5,5 +5,5 @@ import (
 )
 
 var (
-	senderName LM.Sender = `System::System`
+	senderName LM.Sender = `System::System` // This is the name for logging event from this package
 )