diff options
author | Lorenz Meier <lm@inf.ethz.ch> | 2014-07-13 11:45:32 +0200 |
---|---|---|
committer | Lorenz Meier <lm@inf.ethz.ch> | 2014-07-13 11:45:32 +0200 |
commit | afc8908d38ff2eaabc2ca35363ac04697152cb6b (patch) | |
tree | 1aab8e0c9550f53fdccb85d13554bd5884ca89cf /src/modules/commander/commander_helper.h | |
parent | 66d5bc20c095a4dbd937b21c4f5fc1a67205f2d6 (diff) | |
download | px4-firmware-afc8908d38ff2eaabc2ca35363ac04697152cb6b.tar.gz px4-firmware-afc8908d38ff2eaabc2ca35363ac04697152cb6b.tar.bz2 px4-firmware-afc8908d38ff2eaabc2ca35363ac04697152cb6b.zip |
commander: More docs-only changes in headers.
Diffstat (limited to 'src/modules/commander/commander_helper.h')
-rw-r--r-- | src/modules/commander/commander_helper.h | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/src/modules/commander/commander_helper.h b/src/modules/commander/commander_helper.h index e75f2592f..a49c9e263 100644 --- a/src/modules/commander/commander_helper.h +++ b/src/modules/commander/commander_helper.h @@ -1,8 +1,6 @@ /**************************************************************************** * - * Copyright (C) 2013 PX4 Development Team. All rights reserved. - * Author: Thomas Gubler <thomasgubler@student.ethz.ch> - * Julian Oes <joes@student.ethz.ch> + * Copyright (c) 2013, 2014 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 @@ -36,6 +34,9 @@ /** * @file commander_helper.h * Commander helper functions definitions + * + * @author Thomas Gubler <thomasgubler@student.ethz.ch> + * @author Julian Oes <julian@oes.ch> */ #ifndef COMMANDER_HELPER_H_ @@ -77,6 +78,8 @@ void rgbled_set_pattern(rgbled_pattern_t *pattern); * Use integral of current if battery capacity known (BAT_CAPACITY parameter set), * else use simple estimate based on voltage. * + * @param voltage the current battery voltage + * @param discharged the discharged capacity * @return the estimated remaining capacity in 0..1 */ float battery_remaining_estimate_voltage(float voltage, float discharged); |