From 1bb4d5fcbfa98da7abdf2a4dc35591c317460c00 Mon Sep 17 00:00:00 2001 From: Martchus Date: Fri, 27 Sep 2019 16:48:58 +0200 Subject: [PATCH] Document status enums --- connector/syncthingdev.h | 3 +++ connector/syncthingdir.h | 2 ++ 2 files changed, 5 insertions(+) diff --git a/connector/syncthingdev.h b/connector/syncthingdev.h index 95ed928..0cb5837 100644 --- a/connector/syncthingdev.h +++ b/connector/syncthingdev.h @@ -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); diff --git a/connector/syncthingdir.h b/connector/syncthingdir.h index 032a893..9e75524 100644 --- a/connector/syncthingdir.h +++ b/connector/syncthingdir.h @@ -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);