From 15813c3dcdc69b9b4ff32aef271c19873e68bf52 Mon Sep 17 00:00:00 2001 From: Jorge Aparicio Date: Fri, 13 Jul 2018 22:39:29 -0500 Subject: [PATCH] add links to standard, API and implementation to the module level docs --- library/stdarch/coresimd/arm/cmsis.rs | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/library/stdarch/coresimd/arm/cmsis.rs b/library/stdarch/coresimd/arm/cmsis.rs index 0010b4b84aa5..8f150d2cb0a7 100644 --- a/library/stdarch/coresimd/arm/cmsis.rs +++ b/library/stdarch/coresimd/arm/cmsis.rs @@ -1,8 +1,19 @@ -#![allow(non_snake_case)] +//! CMSIS: Cortex Microcontroller Software Interface Standard +//! +//! The version 5 of the standard can be found at: +//! +//! http://arm-software.github.io/CMSIS_5/Core/html/index.html +//! +//! The API reference of the standard can be found at: +//! +//! - Core function access -- http://arm-software.github.io/CMSIS_5/Core/html/group__Core__Register__gr.html +//! - Intrinsic functions for CPU instructions -- http://arm-software.github.io/CMSIS_5/Core/html/group__intrinsic__CPU__gr.html +//! +//! The reference C implementation used as the base of this Rust port can be found at +//! +//! https://github.com/ARM-software/CMSIS_5/blob/5.3.0/CMSIS/Core/Include/cmsis_gcc.h -/// Extracted from [CMSIS 5]'s CMSIS/Core/Include/cmsis_gcc.h -/// -/// [CMSIS 5]: https://github.com/ARM-software/CMSIS_5 +#![allow(non_snake_case)] /* Core function access */