diff --git a/api/apiTools/basicTools.go b/api/apiTools/basicTools.go index 3e470af5c30ad9b7491bf717560bcbb3b2fba74c..eea24345bba8e035b07ccd3cfa2be68d85583ff5 100644 --- a/api/apiTools/basicTools.go +++ b/api/apiTools/basicTools.go @@ -9,6 +9,12 @@ import ( "strings" ) +/* +Class basicTools contains functions for assisting API endpoints +Last update 19.05.2022 Martin Ivesren +@version 1.0 +*/ + func CreatePath(segments []string) string { var finalPath string for _, s := range segments { diff --git a/api/apiTools/errorHandling.go b/api/apiTools/errorHandling.go index 1e395b26b090e1dfd2543faabe31760efd38f451..57e5e77ec49e5a92ad07b2e66e1e0ca7621b4a3b 100644 --- a/api/apiTools/errorHandling.go +++ b/api/apiTools/errorHandling.go @@ -10,7 +10,7 @@ Code inspired by: Page authored by Matt Silverlock from questionable serviecs Last visit: 08.03.2022 -version 0.1 +version 1.0 Last edited 08.03.2022 by Martin Iversen */ diff --git a/api/cmd/main.go b/api/cmd/main.go index 833f9408718936cbc24cdc7348d1fd7ff5f9f1e2..0f763605a49bb52bc8172ddf245552eba9eb6cd6 100644 --- a/api/cmd/main.go +++ b/api/cmd/main.go @@ -9,7 +9,7 @@ import ( /** Class main Will run the api -Version 0.1 +Version 1.0 Last update 08.03.2022 Martin Iversen */ diff --git a/api/database/databaseSetup.go b/api/database/databaseSetup.go index 65874175edb2ee0ea9e0c6c2e83eb120f4d1ce0a..d3cac49a4223077bcf042871de286cd1e0f86584 100644 --- a/api/database/databaseSetup.go +++ b/api/database/databaseSetup.go @@ -11,6 +11,11 @@ import ( "path/filepath" ) +/* +Class databaseSetup.go created for communicating with database +Last update 19.05.2022 +@version 1.0 +*/ // Ctx Initializing the context to be used with firebase var Ctx context.Context diff --git a/api/endpoints/APIHandler.go b/api/endpoints/APIHandler.go index c4e41adee3895d8aa4c25a500b4b45f2cd9a0da8..8e19854387de4609967f4ce8f6d4c32ac90bf733 100644 --- a/api/endpoints/APIHandler.go +++ b/api/endpoints/APIHandler.go @@ -13,7 +13,7 @@ Class APIHandler.go Class forwards requests to the appropriate endpoint and assigns the port of the program Last modified by martiiv@stud.ntnu.no Date: 06.04.2022 -Version 0.8 +Version 1.0 */ var ( InfoLogger *log.Logger diff --git a/api/endpoints/gateway.go b/api/endpoints/gateway.go index e68964f6d363bb6889415312e3d7fabfa6c6a25c..ad3e6157a2615b55d4601523ac92f23dc05f2e48 100644 --- a/api/endpoints/gateway.go +++ b/api/endpoints/gateway.go @@ -16,6 +16,11 @@ import ( "strconv" ) +/** +Class gateway.go created for managing gateways +@version 1.0 +Last edit 19.05.2022 +*/ var gatewayCollection *firestore.CollectionRef var projectCollection *firestore.DocumentRef diff --git a/api/endpoints/homePage.go b/api/endpoints/homePage.go index b760538483e33c9f8cd33056c61d834efbe6359d..15f53605ef53ac829df786e306bd5a92740d4553 100644 --- a/api/endpoints/homePage.go +++ b/api/endpoints/homePage.go @@ -6,6 +6,12 @@ import ( tool "stillasTracker/api/apiTools" ) +/** +Class homepage.go created but never used, +@version 1.0 +last edit 19.05.2022 +*/ + func homePage(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", "application/json") w.Header().Set("Access-Control-Allow-Origin", "*") diff --git a/api/endpoints/profiles.go b/api/endpoints/profiles.go index a83d8daf578fabe4f4d54369236240ac74910708..90d147a35d5ae197b632322c54a551fecd549ef2 100644 --- a/api/endpoints/profiles.go +++ b/api/endpoints/profiles.go @@ -20,7 +20,7 @@ import ( /** Class profiles This class will contain all data formatting and modification regarding the users of the system -Version 0.9 +Version 1.0 Last modified Martin Iversen 07.04.2022 TODO Maybe modularize som functionality the marshall, unmarshall encode routine is repeated often */ diff --git a/api/endpoints/projectTools.go b/api/endpoints/projectTools.go index 143998d59ce08ef2da5a2b85dd79153f7ee9a642..fd806bf26ac3a7099b570ed08be05b59e35d12f6 100644 --- a/api/endpoints/projectTools.go +++ b/api/endpoints/projectTools.go @@ -17,7 +17,7 @@ import ( /* projectTools File contains tools used in the projects.go file Last edited Martin Iversen 07.04.2022 -Version 0.9 +Version 1.0 TODO Delete checkProjectBody? It isn't used */ diff --git a/api/endpoints/projects.go b/api/endpoints/projects.go index 148ac30e6fa91f2a56db5a7b6c96d6b594ea1826..be59a8806a33df68259a4255501362bbe11a97a8 100644 --- a/api/endpoints/projects.go +++ b/api/endpoints/projects.go @@ -22,7 +22,7 @@ import ( Class projects This class will contain all data formatting and handling of the clients projects Class contains the following functions: -Version 0.9 +Version 1.0 Last modified Martin Iversen 07.04.2022 TODO Find alternative for strings.Title since the function is deprecated TODO If possible modularize the unmarshalling and encoding of lists since there is a lot of duplicate code doing this diff --git a/api/endpoints/scaffolding.go b/api/endpoints/scaffolding.go index 14e368cbcd0ab860bc1c5148de63551147162c51..cf8bcce97533a8e7d553c92bae47ecc9dd03e623 100644 --- a/api/endpoints/scaffolding.go +++ b/api/endpoints/scaffolding.go @@ -15,7 +15,7 @@ import ( /** Class scaffolding This class will contain all functions used for the handling of scaffolding units -Version 0.9 +Version 1.0 Last modified Martin Iversen 07.04.2022 TODO make type non case sensitive */ diff --git a/api/endpoints/trackingTools.go b/api/endpoints/trackingTools.go index 8bf36de6e99f6c8739f5a8adeb7a50faccfe9c32..efe31b7587c5eb70d7f3b42b84f9d10ec0056b6f 100644 --- a/api/endpoints/trackingTools.go +++ b/api/endpoints/trackingTools.go @@ -24,8 +24,8 @@ Class gateway The class wil handle all information regarding the cellular gateways in the system The class will contain the following functions: -Version 0.1 -Last modified Martin Iversen +Version 1.0 +Last modified Martin Iversen 19.05.2022 */ func UpdatePosition(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", "application/json") diff --git a/api/mqtt/mqttBroker.go b/api/mqtt/mqttBroker.go index b9a0e6166a15b9dabd7321b0546bea88aee990d7..226e541ab90da360dcf4dc5a7261d53b89c03212 100644 --- a/api/mqtt/mqttBroker.go +++ b/api/mqtt/mqttBroker.go @@ -10,6 +10,12 @@ import ( "strings" ) +/** +Class mqttBroker.go created for implementing an mqtt broker +This functionality was never implemented fully given time constraints +@version 0.5 +last edited Martin Iversen 19.05.2022 +*/ type AdvPacket struct { msg *igs.Message packet *ibs.Payload