Skip to content

Commit a6b9bd9

Browse files
committed
Improved documentation.
1 parent ba404c6 commit a6b9bd9

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

lib/falcon/environment/server.rb

+7
Original file line numberDiff line numberDiff line change
@@ -74,16 +74,23 @@ def cache
7474
false
7575
end
7676

77+
# A client endpoint that can be used to connect to the server.
78+
# @returns [Async::HTTP::Endpoint] The client endpoint.
7779
def client_endpoint
7880
::Async::HTTP::Endpoint.parse(url)
7981
end
8082

8183
# Any scripts to preload before starting the server.
84+
#
85+
# @returns [Array(String)] The list of scripts to preload.
8286
def preload
8387
[]
8488
end
8589

8690
# Make a server instance using the given endpoint. The endpoint may be a bound endpoint, so we take care to specify the protocol and scheme as per the original endpoint.
91+
#
92+
# @parameter endpoint [IO::Endpoint] The endpoint to bind to.
93+
# @returns [Falcon::Server] The server instance.
8794
def make_server(endpoint)
8895
Falcon::Server.new(self.middleware, endpoint, protocol: self.endpoint.protocol, scheme: self.endpoint.scheme)
8996
end

0 commit comments

Comments
 (0)