diff options
| author | Jonas Smedegaard <dr@jones.dk> | 2025-04-01 12:12:53 +0200 |
|---|---|---|
| committer | Jonas Smedegaard <dr@jones.dk> | 2025-04-01 12:12:53 +0200 |
| commit | 44779dfb0143f849e1b4b64e5668adb525d04d7f (patch) | |
| tree | 583fef2c5b6e246911c3c46e00fa65a8dbbc26c4 /Mussel | |
| parent | 9b1c99ba8a63683f59ef4ad93196d3f020af53c6 (diff) | |
tidy comments
Diffstat (limited to 'Mussel')
| -rw-r--r-- | Mussel/Mussel.cpp | 18 | ||||
| -rw-r--r-- | Mussel/Mussel.h | 14 |
2 files changed, 18 insertions, 14 deletions
diff --git a/Mussel/Mussel.cpp b/Mussel/Mussel.cpp index 0bbcb52..b8cc4da 100644 --- a/Mussel/Mussel.cpp +++ b/Mussel/Mussel.cpp @@ -1,12 +1,12 @@ +// SPDX-FileCopyrightText: 2025 Amal Mazrah <mazrah@ruc.dk> +// SPDX-FileCopyrightText: 2025 Jonas Smedegaard <dr@jones.dk> +// SPDX-FileCopyrightText: 2025 Mennatullah Hatim Kassim <stud-mennatulla@ruc.dk> +// SPDX-FileCopyrightText: 2025 Noor Ahmad <noora@ruc.dk> +// SPDX-FileCopyrightText: 2025 Tanishka Suwalka <tanishkas@ruc.dk> +// SPDX-License-Identifier: GPL-3.0-or-later + /// Mussel - a small library for Arduino to emulate a mussel biosensor /// -/// SPDX-FileCopyrightText: 2025 Amal Mazrah <mazrah@ruc.dk> -/// SPDX-FileCopyrightText: 2025 Jonas Smedegaard <dr@jones.dk> -/// SPDX-FileCopyrightText: 2025 Mennatullah Hatim Kassim <stud-mennatulla@ruc.dk> -/// SPDX-FileCopyrightText: 2025 Noor Ahmad <noora@ruc.dk> -/// SPDX-FileCopyrightText: 2025 Tanishka Suwalka <tanishkas@ruc.dk> -/// SPDX-License-Identifier: GPL-3.0-or-later -/// /// * v0.0.1 /// * initial release to radicle /// @@ -24,7 +24,7 @@ Mussel::Mussel(int attitude) { _attitude = attitude; } -/// Constructor for attitudes using a pin +/// Constructor for attitudes using an input pin /// /// @param attitude behavioral profile as integer /// @param pin Used pin as uint8_t @@ -33,7 +33,7 @@ Mussel::Mussel(int attitude, uint8_t pin) { _pin = pin; } -/// Constructor for attitudes using a pin and certain type of sensor +/// Constructor for attitudes using an input pin and a sensor type /// /// @param attitude behavioral profile as integer /// @param pin Used pin as uint8_t diff --git a/Mussel/Mussel.h b/Mussel/Mussel.h index bed275b..3cce885 100644 --- a/Mussel/Mussel.h +++ b/Mussel/Mussel.h @@ -1,8 +1,12 @@ +// SPDX-FileCopyrightText: 2025 Amal Mazrah <mazrah@ruc.dk> +// SPDX-FileCopyrightText: 2025 Jonas Smedegaard <dr@jones.dk> +// SPDX-FileCopyrightText: 2025 Mennatullah Hatim Kassim <stud-mennatulla@ruc.dk> +// SPDX-FileCopyrightText: 2025 Noor Ahmad <noora@ruc.dk> +// SPDX-FileCopyrightText: 2025 Tanishka Suwalka <tanishkas@ruc.dk> +// SPDX-License-Identifier: GPL-3.0-or-later + /// Mussel - a small library for Arduino to emulate a mussel biosensor /// -/// SPDX-License-Identifier: GPL-3.0-or-later -/// SPDX-FileCopyrightText: 2025 Jonas Smedegaard <dr@jones.dk> -/// /// @version 0.0.1 /// @see <https://app.radicle.xyz/nodes/seed.radicle.garden/rad:z2tFBF4gN7ziG9oXtUytVQNYe3VhQ/tree/Mussel/README.md> /// @see <https://moodle.ruc.dk/course/view.php?id=23504> @@ -19,10 +23,10 @@ class Mussel { // Default constructor Mussel(const int attitude); - // Constructor for attitudes using a pin + // Constructor for attitudes using an input pin Mussel(const int attitude, const uint8_t pin); - // Constructor for attitudes using a pin and certain type of sensor + // Constructor for attitudes using an input pin and a sensor type Mussel( const int attitude, const uint8_t pin, |