Skip to content

Commit

Permalink
add links to standard, API and implementation to the module level docs
Browse files Browse the repository at this point in the history
  • Loading branch information
japaric authored and gnzlbg committed Jul 19, 2018
1 parent 0dc8b7d commit 0fa99a1
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions coresimd/arm/cmsis.rs
Original file line number Diff line number Diff line change
@@ -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 */

Expand Down

0 comments on commit 0fa99a1

Please sign in to comment.