Document status enums

This commit is contained in:
Martchus 2019-09-27 16:48:58 +02:00
parent 31e7e4e79e
commit 1bb4d5fcbf
2 changed files with 5 additions and 0 deletions

View File

@ -11,6 +11,9 @@
namespace Data {
/// \brief The SyncthingDevStatus enum represents a Syncthing device status.
/// \remarks The device status is not directly provided by Syncthing and instead deduced by this library from
/// other information and events.
enum class SyncthingDevStatus { Unknown, Disconnected, OwnDevice, Idle, Synchronizing, OutOfSync, Rejected };
QString statusString(SyncthingDevStatus status);

View File

@ -12,6 +12,8 @@
namespace Data {
/// \brief The SyncthingDirStatus enum represents a Syncthing directory status.
/// \remarks It needs to be kept in sync with the states defined in Syncthing's "syncthing/lib/model/folderstate.go".
enum class SyncthingDirStatus { Unknown, Idle, WaitingToScan, Scanning, PreparingToSync, Synchronizing, OutOfSync };
QString LIB_SYNCTHING_CONNECTOR_EXPORT statusString(SyncthingDirStatus status);