Skip to content

Commit 0fa99a1

Browse files
japaricgnzlbg
authored andcommitted
add links to standard, API and implementation to the module level docs
1 parent 0dc8b7d commit 0fa99a1

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

coresimd/arm/cmsis.rs

+15-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
1-
#![allow(non_snake_case)]
1+
//! CMSIS: Cortex Microcontroller Software Interface Standard
2+
//!
3+
//! The version 5 of the standard can be found at:
4+
//!
5+
//! http://arm-software.github.io/CMSIS_5/Core/html/index.html
6+
//!
7+
//! The API reference of the standard can be found at:
8+
//!
9+
//! - Core function access -- http://arm-software.github.io/CMSIS_5/Core/html/group__Core__Register__gr.html
10+
//! - Intrinsic functions for CPU instructions -- http://arm-software.github.io/CMSIS_5/Core/html/group__intrinsic__CPU__gr.html
11+
//!
12+
//! The reference C implementation used as the base of this Rust port can be found at
13+
//!
14+
//! https://github.com/ARM-software/CMSIS_5/blob/5.3.0/CMSIS/Core/Include/cmsis_gcc.h
215
3-
/// Extracted from [CMSIS 5]'s CMSIS/Core/Include/cmsis_gcc.h
4-
///
5-
/// [CMSIS 5]: https://github.com/ARM-software/CMSIS_5
16+
#![allow(non_snake_case)]
617

718
/* Core function access */
819

0 commit comments

Comments
 (0)