added rust documentation comments

This commit is contained in:
Simon Wörner
2017-07-10 15:20:14 +02:00
parent 088867352c
commit fe8806a4d5
12 changed files with 100 additions and 10 deletions

View File

@@ -6,6 +6,7 @@ use std::mem::transmute;
use std::ptr::null_mut;
use std::sync::atomic::Ordering;
/// Constructs a new `EmergencyStop` on heap and returns pointer.
#[no_mangle]
pub extern "C" fn emergency_stop_init(stop: u8) -> *mut EmergencyStop {
match EmergencyStop::new(stop) {
@@ -14,11 +15,13 @@ pub extern "C" fn emergency_stop_init(stop: u8) -> *mut EmergencyStop {
}
}
/// Drops a `EmergencyStop` pointer on heap.
#[no_mangle]
pub extern "C" fn emergency_stop_clean(emergency_stop: *mut EmergencyStop) {
let _emergency_stop: Box<EmergencyStop> = unsafe { transmute(emergency_stop) };
}
/// Returns `EmergencyStop` pointer state.
#[no_mangle]
pub extern "C" fn emergency_stop_get_state(emergency_stop: *mut EmergencyStop) -> bool {
let emergency_stop = unsafe { &mut *emergency_stop };