diff options
author | Lorenz Meier <lm@inf.ethz.ch> | 2014-06-01 15:36:26 +0200 |
---|---|---|
committer | Lorenz Meier <lm@inf.ethz.ch> | 2014-06-01 15:36:26 +0200 |
commit | ad811304c89d00d6432ec871916b7a82c8b3cbe7 (patch) | |
tree | 53457ec3da7c235fd507383781d8e591bd6d9395 | |
parent | 8aeb327e7a2077a6691057fd645cecefccacf0df (diff) | |
download | px4-firmware-ad811304c89d00d6432ec871916b7a82c8b3cbe7.tar.gz px4-firmware-ad811304c89d00d6432ec871916b7a82c8b3cbe7.tar.bz2 px4-firmware-ad811304c89d00d6432ec871916b7a82c8b3cbe7.zip |
actuator_armed: Fixed comments and doxygen, no C-level changes
-rw-r--r-- | src/modules/uORB/topics/actuator_armed.h | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/src/modules/uORB/topics/actuator_armed.h b/src/modules/uORB/topics/actuator_armed.h index 6e944ffee..a98d3fc3a 100644 --- a/src/modules/uORB/topics/actuator_armed.h +++ b/src/modules/uORB/topics/actuator_armed.h @@ -1,6 +1,6 @@ /**************************************************************************** * - * Copyright (C) 2013 PX4 Development Team. All rights reserved. + * Copyright (c) 2013 PX4 Development Team. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions @@ -44,15 +44,25 @@ #include <stdint.h> #include "../uORB.h" +/** + * @addtogroup topics + * @{ + */ + /** global 'actuator output is live' control. */ struct actuator_armed_s { - uint64_t timestamp; - bool armed; /**< Set to true if system is armed */ - bool ready_to_arm; /**< Set to true if system is ready to be armed */ - bool lockdown; /**< Set to true if actuators are forced to being disabled (due to emergency or HIL) */ + uint64_t timestamp; /**< Microseconds since system boot */ + bool armed; /**< Set to true if system is armed */ + bool ready_to_arm; /**< Set to true if system is ready to be armed */ + bool lockdown; /**< Set to true if actuators are forced to being disabled (due to emergency or HIL) */ }; +/** + * @} + */ + +/* register this as object request broker structure */ ORB_DECLARE(actuator_armed); #endif
\ No newline at end of file |