From b6b102effbfe6abf5dfac4dfcc5643bd4784d775 Mon Sep 17 00:00:00 2001
From: Markus Reiter <me@reitermark.us>
Date: Mon, 17 Aug 2020 06:01:54 +0200
Subject: [PATCH] Document `FreePort`.

---
 Library/Homebrew/formula_free_port.rb | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/Library/Homebrew/formula_free_port.rb b/Library/Homebrew/formula_free_port.rb
index 894b5cf8c2..2067ca287f 100644
--- a/Library/Homebrew/formula_free_port.rb
+++ b/Library/Homebrew/formula_free_port.rb
@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
-module Homebrew
-  module FreePort
-    require "socket"
+require "socket"
 
+module Homebrew
+  # Helper function for finding a free port.
+  #
+  # @api private
+  module FreePort
+    # Returns a free port.
+    # @api public
     def free_port
       server = TCPServer.new 0
       _, port, = server.addr