mohr/fsfw
1
0
Fork 0
forked from fsfw/fsfw
Code Pull Requests Activity

more occurences in comments

Browse Source
This commit is contained in:
Ulrich Mohr
2022-08-16 12:12:21 +02:00
parent fc34d56239
commit f63f3fa564
68 changed files with 195 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/fsfw_hal/common/gpio/GpioIF.h
View File

@ -29,7 +29,7 @@ class GpioIF {
* functionality to pull a certain GPIO to high logic level.
*
* @param gpioId A unique number which specifies the GPIO to drive.
* @return Returns RETURN_OK for success. This should never return returnvalue::FAILED.
* @return Returns returnvalue::OK for success. This should never return returnvalue::FAILED.
*/
virtual ReturnValue_t pullHigh(gpioId_t gpioId) = 0;

6
src/fsfw_hal/linux/CommandExecutor.h
View File

@ -68,7 +68,7 @@ class CommandExecutor {
* the result of the system call was not 0. The error value can be accessed using
* getLastError
* - In non-blocking mode, this call will start
* the execution and then return RETURN_OK
* the execution and then return returnvalue::OK
*/
ReturnValue_t execute();
/**
@ -77,7 +77,7 @@ class CommandExecutor {
* @return
* - BYTES_READ if bytes have been read from the executing process. It is recommended to call
* check again after this
* - RETURN_OK execution is pending, but no bytes have been read from the executing process
* - returnvalue::OK execution is pending, but no bytes have been read from the executing process
* - returnvalue::FAILED if execution has failed, error value can be accessed using getLastError
* - EXECUTION_FINISHED if the process was executed successfully
* - NO_COMMAND_LOADED_OR_PENDING self-explanatory
@ -87,7 +87,7 @@ class CommandExecutor {
/**
* Abort the current command. Should normally not be necessary, check can be used to find
* out whether command execution was successful
* @return RETURN_OK
* @return returnvalue::OK
*/
ReturnValue_t close();

2
src/fsfw_hal/linux/gpio/LinuxLibgpioIF.h
View File

@ -71,7 +71,7 @@ class LinuxLibgpioIF : public GpioIF, public SystemObject {
*
* @param mapToAdd The GPIOs which shall be added to the gpioMap.
*
* @return RETURN_OK if successful, otherwise returnvalue::FAILED
* @return returnvalue::OK if successful, otherwise returnvalue::FAILED
*/
ReturnValue_t checkForConflicts(GpioMap& mapToAdd);

2
src/fsfw_hal/linux/i2c/I2cComIF.h
View File

@ -49,7 +49,7 @@ class I2cComIF : public DeviceCommunicationIF, public SystemObject {
* @param deviceFile The name of the device file. E.g. i2c-0
* @param i2cAddress The address of the i2c slave device.
* @param fileDescriptor Pointer to device descriptor.
* @return RETURN_OK if successful, otherwise returnvalue::FAILED.
* @return returnvalue::OK if successful, otherwise returnvalue::FAILED.
*/
ReturnValue_t openDevice(std::string deviceFile, address_t i2cAddress, int *fileDescriptor);
};