more occurences in comments

This commit is contained in:
2022-08-16 12:12:21 +02:00
parent fc34d56239
commit f63f3fa564
68 changed files with 195 additions and 195 deletions

View File

@ -53,7 +53,7 @@ class AssemblyBase : public SubsystemBase {
* @param mode
* @param submode
* @return
* - @c RETURN_OK if ok
* - @c returnvalue::OK if ok
* - @c NEED_SECOND_STEP if children need to be commanded again
*/
virtual ReturnValue_t commandChildren(Mode_t mode, Submode_t submode) = 0;

View File

@ -61,7 +61,7 @@ class DeviceCommunicationIF {
* initialization.
* @param cookie
* @return
* - @c RETURN_OK if initialization was successfull
* - @c returnvalue::OK if initialization was successfull
* - Everything else triggers failure event with returnvalue as parameter 1
*/
virtual ReturnValue_t initializeInterface(CookieIF *cookie) = 0;
@ -74,7 +74,7 @@ class DeviceCommunicationIF {
* @param data
* @param len If this is 0, nothing shall be sent.
* @return
* - @c RETURN_OK for successfull send
* - @c returnvalue::OK for successfull send
* - Everything else triggers failure event with returnvalue as parameter 1
*/
virtual ReturnValue_t sendMessage(CookieIF *cookie, const uint8_t *sendData, size_t sendLen) = 0;
@ -84,7 +84,7 @@ class DeviceCommunicationIF {
* Get send confirmation that the data in sendMessage() was sent successfully.
* @param cookie
* @return
* - @c RETURN_OK if data was sent successfully but a reply is expected
* - @c returnvalue::OK if data was sent successfully but a reply is expected
* - NO_REPLY_EXPECTED if data was sent successfully and no reply is expected
* - Everything else to indicate failure
*/
@ -99,7 +99,7 @@ class DeviceCommunicationIF {
*
* @param cookie
* @param requestLen Size of data to read
* @return - @c RETURN_OK to confirm the request for data has been sent.
* @return - @c returnvalue::OK to confirm the request for data has been sent.
* - Everything else triggers failure event with
* returnvalue as parameter 1
*/
@ -113,7 +113,7 @@ class DeviceCommunicationIF {
* @param buffer [out] Set reply here (by using *buffer = ...)
* @param size [out] size pointer to set (by using *size = ...).
* Set to 0 if no reply was received
* @return - @c RETURN_OK for successfull receive
* @return - @c returnvalue::OK for successfull receive
* - @c NO_REPLY_RECEIVED if not reply was received. Setting size to
* 0 has the same effect
* - Everything else triggers failure event with

View File

@ -144,7 +144,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
* 4. Decrements counter for timeout of replies by calling
* decrementDeviceReplyMap()
* 5. Performs FDIR check for failures
* 6. If the device mode is MODE_OFF, return RETURN_OK.
* 6. If the device mode is MODE_OFF, return returnvalue::OK.
* Otherwise, perform the Action property and performs depending
* on value specified by input value counter (incremented in PST).
* The child class tells base class what to do by setting this value.
@ -160,7 +160,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
* - GET_READ: Access requested reading data by calling doGetRead()
* which calls readReceivedMessage of #communicationInterface
* @param counter Specifies which Action to perform
* @return RETURN_OK for successful execution
* @return returnvalue::OK for successful execution
*/
virtual ReturnValue_t performOperation(uint8_t counter) override;
@ -281,7 +281,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
*
* @param[out] id the device command id that has been built
* @return
* - @c RETURN_OK to send command after setting #rawPacket and
* - @c returnvalue::OK to send command after setting #rawPacket and
* #rawPacketLen.
* - @c NOTHING_TO_SEND when no command is to be sent.
* - Anything else triggers an even with the returnvalue as a parameter.
@ -305,7 +305,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
*
* @param[out] id the device command id built
* @return
* - @c RETURN_OK when a command is to be sent
* - @c returnvalue::OK when a command is to be sent
* - @c NOTHING_TO_SEND when no command is to be sent
* - Anything else triggers an even with the returnvalue as a parameter
*/
@ -327,7 +327,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
* @param commandData Pointer to the data from the direct command
* @param commandDataLen Length of commandData
* @return
* - @c RETURN_OK to send command after #rawPacket and #rawPacketLen
* - @c returnvalue::OK to send command after #rawPacket and #rawPacketLen
* have been set.
* - @c HasActionsIF::EXECUTION_COMPLETE to generate a finish reply immediately. This can
* be used if no reply is expected
@ -357,7 +357,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
* @param[out] foundLen length of the data found. Is to be set in function,
* buffer is scanned at previous position + foundLen.
* @return
* - @c RETURN_OK a valid packet was found at @c start, @c foundLen is valid
* - @c returnvalue::OK a valid packet was found at @c start, @c foundLen is valid
* - @c returnvalue::FAILED no reply could be found starting at @c start,
* implies @c foundLen is not valid, base class will call scanForReply()
* again with ++start
@ -387,7 +387,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
* @param id the id found by scanForReply()
* @param packet
* @return
* - @c RETURN_OK when the reply was interpreted.
* - @c returnvalue::OK when the reply was interpreted.
* - @c IGNORE_REPLY_DATA Ignore the reply and don't reset reply cycle
* counter.
* - @c returnvalue::FAILED when the reply could not be interpreted,
@ -450,7 +450,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
* @param countdown Instead of using maxDelayCycles to timeout a device reply it is also possible
* to provide a pointer to a Countdown object which will signal the timeout
* when expired
* @return - @c RETURN_OK when the command was successfully inserted,
* @return - @c returnvalue::OK when the command was successfully inserted,
* - @c returnvalue::FAILED else.
*/
ReturnValue_t insertInCommandAndReplyMap(DeviceCommandId_t deviceCommand, uint16_t maxDelayCycles,
@ -471,7 +471,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
* @param countdown Instead of using maxDelayCycles to timeout a device reply it is also possible
* to provide a pointer to a Countdown object which will signal the timeout
* when expired
* @return - @c RETURN_OK when the command was successfully inserted,
* @return - @c returnvalue::OK when the command was successfully inserted,
* - @c returnvalue::FAILED else.
*/
ReturnValue_t insertInReplyMap(DeviceCommandId_t deviceCommand, uint16_t maxDelayCycles,
@ -481,7 +481,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
/**
* @brief A simple command to add a command to the commandList.
* @param deviceCommand The command to add
* @return - @c RETURN_OK when the command was successfully inserted,
* @return - @c returnvalue::OK when the command was successfully inserted,
* - @c returnvalue::FAILED else.
*/
ReturnValue_t insertInCommandMap(DeviceCommandId_t deviceCommand,
@ -518,7 +518,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
* @param periodic Indicates if the command is periodic (i.e. it is sent
* by the device repeatedly without request) or not. Default is aperiodic (0).
* Warning: The setting always overrides the value that was entered in the map.
* @return - @c RETURN_OK when the command was successfully inserted,
* @return - @c returnvalue::OK when the command was successfully inserted,
* - @c returnvalue::FAILED else.
*/
ReturnValue_t updateReplyMapEntry(DeviceCommandId_t deviceReply, uint16_t delayCycles,
@ -602,7 +602,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
* @param mode
* @param submode
* @return
* - @c RETURN_OK if valid
* - @c returnvalue::OK if valid
* - @c returnvalue::FAILED if invalid
*/
virtual ReturnValue_t isModeCombinationValid(Mode_t mode, Submode_t submode);
@ -622,7 +622,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
* @param[out] switches pointer to an array of switches
* @param[out] numberOfSwitches length of returned array
* @return
* - @c RETURN_OK if the parameters were set
* - @c returnvalue::OK if the parameters were set
* - @c returnvalue::FAILED if no switches exist
*/
virtual ReturnValue_t getSwitches(const uint8_t **switches, uint8_t *numberOfSwitches);
@ -977,7 +977,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
* - A failure code may be returned if something went fundamentally wrong.
*
* @param deviceCommand
* @return - RETURN_OK if a reply was activated.
* @return - returnvalue::OK if a reply was activated.
* - NO_REPLY_EXPECTED if there was no reply found. This is not an
* error case as many commands do not expect a reply.
*/
@ -1004,7 +1004,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
*
* @param[out] id the device command id built
* @return
* - @c RETURN_OK when a command is to be sent
* - @c returnvalue::OK when a command is to be sent
* - not @c NOTHING_TO_SEND when no command is to be sent
*/
virtual ReturnValue_t buildChildRawCommand();
@ -1085,7 +1085,7 @@ class DeviceHandlerBase : public DeviceHandlerIF,
/**
* Checks if current handler state allows reception of external device commands.
* Default implementation allows commands only in plain MODE_ON and MODE_NORMAL.
* @return RETURN_OK if commands are accepted, anything else otherwise.
* @return returnvalue::OK if commands are accepted, anything else otherwise.
*/
virtual ReturnValue_t acceptExternalDeviceCommands();
@ -1273,9 +1273,9 @@ class DeviceHandlerBase : public DeviceHandlerIF,
* @param[out] data
* @param[out] len
* @return
* - @c RETURN_OK @c data is valid
* - @c returnvalue::OK @c data is valid
* - @c returnvalue::FAILED IPCStore is nullptr
* - the return value from the IPCStore if it was not @c RETURN_OK
* - the return value from the IPCStore if it was not @c returnvalue::OK
*/
ReturnValue_t getStorageData(store_address_t storageAddress, uint8_t **data, size_t *len);