Update comments

IgnoreWarnings · IgnoreWarnings · commit 29f2698d2285 · 2024-09-24T09:01:25.000+02:00
Signed-off-by: Pascal Bauer &lt;pascal.bauer@rwth-aachen.de&gt;
diff --git a/common/include/villas/kernel/devices/device.hpp b/common/include/villas/kernel/devices/device.hpp
@@ -1,4 +1,4 @@
-/* Interface for Linux/Unix device drivers
+/* Interface for Linux/Unix devices.
  *
  * Author: Pascal Bauer <pascal.bauer@rwth-aachen.de>
  *
diff --git a/common/include/villas/kernel/devices/driver.hpp b/common/include/villas/kernel/devices/driver.hpp
@@ -1,4 +1,4 @@
-/* Driver
+/* Interface for Linux/Unix device drivers
  *
  * Author: Pascal Bauer <pascal.bauer@rwth-aachen.de>
  *
diff --git a/common/include/villas/kernel/devices/ip_device.hpp b/common/include/villas/kernel/devices/ip_device.hpp
@@ -1,4 +1,4 @@
-/* IpDevice
+/* IpDevice: Linux/Unix device which represents an IP component of a fpga
  *
  * Author: Pascal Bauer <pascal.bauer@rwth-aachen.de>
  *
@@ -22,7 +22,7 @@ class IpDevice : public PlatformDevice {
 
 private:
   IpDevice() = delete;
-  IpDevice(const std::filesystem::path valid_path)
+  IpDevice(const std::filesystem::path valid_path) //! Dont allow unvalidated paths
       : PlatformDevice(valid_path){};
 
 public:
diff --git a/common/include/villas/kernel/devices/platform_device.hpp b/common/include/villas/kernel/devices/platform_device.hpp
@@ -1,4 +1,4 @@
-/* Platform Device
+/* Platform Device: Platform bus based Linux/Unix device.
  *
  * Author: Pascal Bauer <pascal.bauer@rwth-aachen.de>
  *

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/* Interface for Linux/Unix device drivers`
	`1`	`+/* Interface for Linux/Unix devices.`
`2`	`2`	`*`
`3`	`3`	`* Author: Pascal Bauer <pascal.bauer@rwth-aachen.de>`
`4`	`4`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/* Driver`
	`1`	`+/* Interface for Linux/Unix device drivers`
`2`	`2`	`*`
`3`	`3`	`* Author: Pascal Bauer <pascal.bauer@rwth-aachen.de>`
`4`	`4`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/* IpDevice`
	`1`	`+/* IpDevice: Linux/Unix device which represents an IP component of a fpga`
`2`	`2`	`*`
`3`	`3`	`* Author: Pascal Bauer <pascal.bauer@rwth-aachen.de>`
`4`	`4`	`*`
`@@ -22,7 +22,7 @@ class IpDevice : public PlatformDevice {`
`22`	`22`
`23`	`23`	`private:`
`24`	`24`	`IpDevice() = delete;`
`25`		`- IpDevice(const std::filesystem::path valid_path)`
	`25`	`+ IpDevice(const std::filesystem::path valid_path) //! Dont allow unvalidated paths`
`26`	`26`	`: PlatformDevice(valid_path){};`
`27`	`27`
`28`	`28`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/* Platform Device`
	`1`	`+/* Platform Device: Platform bus based Linux/Unix device.`
`2`	`2`	`*`
`3`	`3`	`* Author: Pascal Bauer <pascal.bauer@rwth-aachen.de>`
`4`	`4`	`*`