Document FreePort.

2020-08-17 06:01:54 +02:00 · 2020-08-17 06:01:54 +02:00 · b6b102effb
commit b6b102effb
parent 3d1f0ded39
1 changed files with 8 additions and 3 deletions
--- 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