From d08d366e75ffab8bb779b63bb3b08811f67a7403 Mon Sep 17 00:00:00 2001 From: Piotr Esden-Tempski Date: Mon, 12 Nov 2012 15:43:45 -0800 Subject: [doc] Added preliminary STM32 CAN documentation. --- include/libopencm3/stm32/can.h | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'include/libopencm3') diff --git a/include/libopencm3/stm32/can.h b/include/libopencm3/stm32/can.h index cdb5df1..c531394 100644 --- a/include/libopencm3/stm32/can.h +++ b/include/libopencm3/stm32/can.h @@ -1,3 +1,17 @@ +/** @defgroup can_defines CAN defines + +@ingroup STM32F_defines + +@brief libopencm3 Defined Constants and Types for STM32 CAN + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2010 Piotr Esden-Tempski + +@date 12 November 2012 + +LGPL License Terms @ref lgpl_license +*/ /* * This file is part of the libopencm3 project. * @@ -23,11 +37,19 @@ #include #include +/**@{*/ + /* --- Convenience macros -------------------------------------------------- */ /* CAN register base adresses (for convenience) */ +/*****************************************************************************/ +/** @defgroup can_reg_base CAN register base address +@ingroup can_defines + +@{*/ #define CAN1 BX_CAN1_BASE #define CAN2 BX_CAN2_BASE +/**@}*/ /* --- CAN registers ------------------------------------------------------- */ -- cgit v1.2.3