Mario Bambagini / ssWi

Dependents:   rover_car rover_pc supervisor watering_unit ... more

Revision:
25:83172a067b57
Parent:
15:fb0f6cbc0ed5
diff -r 80345e511574 -r 83172a067b57 ssWiTypes.hpp
--- a/ssWiTypes.hpp	Mon Apr 20 20:27:01 2020 +0000
+++ b/ssWiTypes.hpp	Tue Apr 21 08:23:47 2020 +0000
@@ -5,11 +5,15 @@
 #ifndef __SHARED_SLOTTED_TYPES_HPP__
 #define __SHARED_SLOTTED_TYPES_HPP__
 
-/** \brief tyoe of the port IDentifier
+/** \brief type of the port identifier
+ *
+ * it must be one byte only
  */
 typedef char PortID;
 
 /** \brief type of the Value exchanged through the port
+ *
+ * it must be a type that can be used with std::atomic
  */
 typedef int PortValue;