ALPAKA/sta-core
1
0
Fork 0
mirror of https://git.intern.spaceteamaachen.de/ALPAKA/sta-core.git synced 2025-09-29 05:17:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update doc

Browse Source
This commit is contained in:
Henrik Stickann
2022-05-10 02:12:44 +02:00
parent e2854fceee
commit b73e03fddf
8 changed files with 120 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
include/sta/intf/can/controller.hpp
View File

@@ -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>

36
include/sta/intf/can/id.hpp
View File

@@ -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