From b7e96e6096589de8d77ce7e38c4fb69311254ee2 Mon Sep 17 00:00:00 2001
From: Markus Reiter <me@reitermark.us>
Date: Sun, 9 Aug 2020 03:16:22 +0200
Subject: [PATCH] Document `LockFile`.

---
 Library/Homebrew/lock_file.rb | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/Library/Homebrew/lock_file.rb b/Library/Homebrew/lock_file.rb
index 99c1afda5e..88f017a170 100644
--- a/Library/Homebrew/lock_file.rb
+++ b/Library/Homebrew/lock_file.rb
@@ -2,6 +2,9 @@
 
 require "fcntl"
 
+# A lock file.
+#
+# @api private
 class LockFile
   attr_reader :path
 
@@ -43,12 +46,18 @@ class LockFile
   end
 end
 
+# A lock file for a formula.
+#
+# @api private
 class FormulaLock < LockFile
   def initialize(name)
     super("#{name}.formula")
   end
 end
 
+# A lock file for a cask.
+#
+# @api private
 class CaskLock < LockFile
   def initialize(name)
     super("#{name}.cask")