Update doc

include/sta/intf/can/controller.hpp

@@ -7,20 +7,15 @@
 
 /**
  * @defgroup can CAN
- * @brief CAN Controller interface definition.
+ * @brief CAN controller driver interface.
  */
 
 /**
  * @defgroup canAPI API
  * @ingroup can
- * @brief Public library interface.
+ * @brief Public interface.
  */
 
-/**
- * @defgroup canBuildConfig Build config
- * @ingroup can
- * @brief Build configuration options.
- */
 
 #include <sta/intf/can/filter.hpp>
 #include <sta/intf/can/headers.hpp>

include/sta/intf/can/id.hpp

@@ -57,10 +57,46 @@ namespace sta
 	// Comparison operators
 	//
 
+	/**
+	 * @brief Equal to operator.
+	 *
+	 * @param lhs   Left hand side CAN ID
+	 * @param rhs   Right hand side CAN ID
+	 * @return      True if CAN IDs are equal
+	 *
+	 * @ingroup canID
+	 */
 	bool operator ==(const CanId & lhs, const CanId & rhs);
+	/**
+	 * @brief Not equal to operator.
+	 *
+	 * @param lhs   Left hand side CAN ID
+	 * @param rhs   Right hand side CAN ID
+	 * @return      True if CAN IDs are not equal
+	 *
+	 * @ingroup canID
+	 */
 	bool operator !=(const CanId & lhs, const CanId & rhs);
 
+	/**
+	 * @brief Equal to operator.
+	 *
+	 * @param lhs   Left hand side CAN Frame ID
+	 * @param rhs   Right hand side CAN Frame ID
+	 * @return      True if CAN Frame IDs are equal
+	 *
+	 * @ingroup canID
+	 */
 	bool operator ==(const CanFrameId & lhs, const CanFrameId & rhs);
+	/**
+	 * @brief Not equal to operator.
+	 *
+	 * @param lhs   Left hand side CAN Frame ID
+	 * @param rhs   Right hand side CAN Frame ID
+	 * @return      True if CAN Frame IDs are not equal
+	 *
+	 * @ingroup canID
+	 */
 	bool operator !=(const CanFrameId & lhs, const CanFrameId & rhs);
 } // namespace sta
 

include/sta/intf/spi_interface.hpp

@@ -20,7 +20,6 @@ namespace sta
 	{
 	public:
 		/**
-		 * @param settings  SPI interface settings
 		 * @param mutex     Mutex object for managing shared access. Pass nullptr for no access control
 		 */
 		SpiInterface(Mutex * mutex = nullptr);

include/sta/intf/time.hpp

@@ -9,7 +9,17 @@
 
 namespace sta
 {
+	/**
+	 * @brief Signature for millisecond precision time.
+	 *
+	 * @return Time in milliseconds
+	 */
 	using TimeMsFn = uint32_t (*)();
+	/**
+	 * @brief Signature for microseconds precision time.
+	 *
+	 * @return Time in microseconds
+	 */
 	using TimeUsFn = uint32_t (*)();
 } // namespace sta