docs: add remaining docs for classes in app/logical.

2021-06-23 20:32:59 -05:00
parent c6855261fe
commit 00ca7526bb
47 changed files with 705 additions and 25 deletions
--- a/app/logical/storage_manager/rclone.rb
+++ b/app/logical/storage_manager/rclone.rb
@@ -1,3 +1,8 @@
+# A StorageManager that stores file on remote filesystem using rclone. Rclone
+# can store files on most cloud storage systems. Requires the `rclone` binary to
+# be installed and configured.
+#
+# @see https://rclone.org/
 class StorageManager::Rclone < StorageManager
  class Error < StandardError; end
  attr_reader :remote, :bucket, :rclone_path, :rclone_options
--- a/app/logical/storage_manager/sftp.rb
+++ b/app/logical/storage_manager/sftp.rb
@@ -1,3 +1,4 @@
+# A StorageManager that stores files on a remote filesystem using SFTP.
 class StorageManager::SFTP < StorageManager
  DEFAULT_PERMISSIONS = 0o644