update docs
All checks were successful
EIVE/eive-obsw/pipeline/pr-develop This commit looks good

This commit is contained in:
Robin Müller 2023-01-20 12:31:42 +01:00
parent 3d0ecadb1f
commit 45413726e7
No known key found for this signature in database
GPG Key ID: 71B58F8A3CDFA9AC

View File

@ -58,10 +58,12 @@ class SolarArrayDeploymentHandler : public ExecutableObjectIF,
public SystemObject,
public HasActionsIF {
public:
//! Manual deployment of the solar arrays. Burn time, channel switch interval and dry run flag
//! are supplied as parameters. There are following cases to consider
//! Manual deployment of the solar arrays. Burn time, channel switch interval, initial
//! burn channel and dry run flag are supplied as parameters. There are following cases to
//! consider.
//!
//! - Channel switch interval greater or equal to burn time: Only burn one channel
//! - Channel switch interval greater or equal to burn time: Only burn one channel. The init
//! burn channel parameter can be used to select which channel is burned.
//! - Channel switch interval half of burn time: Burn each channel for half of the burn time.
//!
//! The dry run flag can be used to avoid actually toggling IO pins and only test the