From 8d4f7a5bc0392b82cef6ba3bcb8e304f8dda3036 Mon Sep 17 00:00:00 2001 From: Russell Stanley Date: Wed, 5 Jan 2022 15:22:29 +1030 Subject: [PATCH] Add description, author and license comment --- turbidity/main.go | 25 +++++++++++++++++++++++++ turbidity/results.go | 25 +++++++++++++++++++++++++ turbidity/turbidity.go | 28 +++++++++++++++++++++++++++- 3 files changed, 77 insertions(+), 1 deletion(-) diff --git a/turbidity/main.go b/turbidity/main.go index 5ea8847c..82472aaf 100644 --- a/turbidity/main.go +++ b/turbidity/main.go @@ -1,5 +1,30 @@ +//go:build !nocv // +build !nocv +/* +DESCRIPTION +Turbidity is a program to measure water clarity using computer vison + +AUTHORS +Russell Stanley + +LICENSE + Copyright (C) 2020 the Australian Ocean Lab (AusOcean) + + It is free software: you can redistribute it and/or modify them + 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. + + It 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 + in gpl.txt. If not, see http://www.gnu.org/licenses. +*/ + package main import ( diff --git a/turbidity/results.go b/turbidity/results.go index 7a2fd3fd..455e31e7 100644 --- a/turbidity/results.go +++ b/turbidity/results.go @@ -1,5 +1,30 @@ +//go:build !nocv // +build !nocv +/* +DESCRIPTION +Results struct used to store results from the turbidity sensor + +AUTHORS +Russell Stanley + +LICENSE + Copyright (C) 2020 the Australian Ocean Lab (AusOcean) + + It is free software: you can redistribute it and/or modify them + 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. + + It 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 + in gpl.txt. If not, see http://www.gnu.org/licenses. +*/ + package main // struct to hold the results of the turbidity sensor. diff --git a/turbidity/turbidity.go b/turbidity/turbidity.go index 7deca9cc..fb5d29f5 100644 --- a/turbidity/turbidity.go +++ b/turbidity/turbidity.go @@ -1,4 +1,30 @@ -// +build !nocv +//go:build !ignore +// +build !ignore + +/* +DESCRIPTION +Holds the turbidity sensor struct. Can evaluate 4x4 chessboard markers +in an image to measure the sharpness and contrast. + +AUTHORS +Russell Stanley + +LICENSE + Copyright (C) 2020 the Australian Ocean Lab (AusOcean) + + It is free software: you can redistribute it and/or modify them + 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. + + It 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 + in gpl.txt. If not, see http://www.gnu.org/licenses. +*/ package main