Index: firmware/App/Controllers/Valves.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Controllers/Valves.c (.../Valves.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Controllers/Valves.c (.../Valves.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -55,9 +55,8 @@ /*********************************************************************//** * @brief * The initValves function initializes the Valves module. - * @details - * Inputs : none - * Outputs : Valves module initialized + * @details Inputs: none + * @details Outputs: Valves module initialized * @return none *************************************************************************/ void initValves( void ) @@ -81,9 +80,8 @@ /*********************************************************************//** * @brief * The execValves function executes the valves driver. - * @details - * Inputs : valvesStates, valveStateMismatchCounter - * Outputs : valvesStates, valveStateMismatchCounter + * @details Inputs: valvesStates, valveStateMismatchCounter + * @details Outputs: valvesStates, valveStateMismatchCounter * @return none *************************************************************************/ void execValves( void ) @@ -116,9 +114,8 @@ * @brief * The checkValveStateName function checks the validity of requested valve * state name for given valve. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @param valveID ID of valve to check a valve state name for * @param valveStateName valve state name to check for given valve ID * @return TRUE if given valveStateName is appropriate for given valve ID, FALSE if not. @@ -224,9 +221,8 @@ /*********************************************************************//** * @brief * The getPublishValveStateInterval function gets the valves states publication interval. - * @details - * Inputs : valvesStatesPublishInterval - * Outputs : none + * @details Inputs: valvesStatesPublishInterval + * @details Outputs: none * @return the current valves states publication interval (in task intervals) *************************************************************************/ static U32 getPublishValvesStatesInterval( void ) @@ -245,9 +241,8 @@ * @brief * The fromU32ArrayToU16 function converts an array of U32 valve states * to U16 valvesStates that can be passed to FPGA for setting valves. - * @details - * Inputs : valveStates[] - * Outputs : none + * @details Inputs: valveStates[] + * @details Outputs: none * @return converted U16 bit field for currently commanded valve states *************************************************************************/ static U16 fromU32ArrayToU16( void ) @@ -268,9 +263,8 @@ * @brief * The convertValveStateNameToValveState function converts valve state \n * name to its corresponding de-energized (0) or energized (1) valve state. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @param valveStateName valve state name enumeration to convert to energized/de-energized * @return converted valve state for given valve state name *************************************************************************/ @@ -339,9 +333,8 @@ /*********************************************************************//** * @brief * The setValveState function sets the valve state for given valve. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @param valveID ID of valve to set state for * @param valveStateName name of valve state to set given valve to * @return TRUE if new valve state is set for given valve ID, FALSE if not. @@ -369,9 +362,8 @@ /*********************************************************************//** * @brief * The getValveState function gets the current valve state for given valve. - * @details - * Inputs : valveStates[] - * Outputs : none + * @details Inputs: valveStates[] + * @details Outputs: none * @param valveID ID of valve to get state for * @return the current valve state for given valve *************************************************************************/ @@ -401,9 +393,8 @@ /*********************************************************************//** * @brief * The publishValvesStates function publishes DG valves states at the set interval. - * @details - * Inputs : valvesStatesPublicationTimerCounter - * Outputs : DG valves states are published to CAN bus on interval. + * @details Inputs: valvesStatesPublicationTimerCounter + * @details Outputs: DG valves states are published to CAN bus on interval. * @return none *************************************************************************/ static void publishValvesStates( void ) @@ -426,9 +417,8 @@ * @brief * The testSetValvesStatesPublishIntervalOverride function overrides the * valves states publish interval. - * @details - * Inputs : none - * Outputs : valvesStatesPublishInterval + * @details Inputs: none + * @details Outputs: valvesStatesPublishInterval * @param value override valves states publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -452,9 +442,8 @@ * @brief * The testResetValvesStatesPublishIntervalOverride function resets the override * of the valves states publish interval. - * @details - * Inputs : none - * Outputs : valvesStatesPublishInterval + * @details Inputs: none + * @details Outputs: valvesStatesPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetValvesStatesPublishIntervalOverride( void ) @@ -475,8 +464,8 @@ * @brief * The testSetValveStateOverride function overrides the value of the * specified valve with a given value. - * Inputs : none - * Outputs : valves[] + * @details Inputs: none + * @details Outputs: valves[] * @param valveID ID of valve to override for * @param value override value for the given valve ID * @return TRUE if override successful, FALSE if not @@ -501,9 +490,8 @@ /*********************************************************************//** * @brief * The testResetValveStateOverride function resets the override of the specified valve. - * @details - * Inputs : none - * Outputs : valves[] + * @details Inputs: none + * @details Outputs: valves[] * @param valveID ID of valve to reset override state for * @return TRUE if override successful, FALSE if not *************************************************************************/