Documentation updates

hummingbird-project · Jan 22, 2024 · 1e4ccb1 · 1e4ccb1
1 parent 287f865
commit 1e4ccb1
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/Sources/Hummingbird/Router/Router.swift b/Sources/Hummingbird/Router/Router.swift
@@ -65,12 +65,12 @@ public final class HBRouter<Context: HBBaseRequestContext>: HBRouterMethods, HBR
         }
     }
 
-    /// build router
+    /// build responder from router
     public func buildResponder() -> HBRouterResponder<Context> {
         HBRouterResponder(context: Context.self, trie: self.trie.build(), notFoundResponder: self.middlewares.constructResponder(finalResponder: NotFoundResponder<Context>()))
     }
 
-    /// Add path for closure returning type conforming to ResponseFutureEncodable
+    /// Add path for closure returning type conforming to HBResponseGenerator
     @discardableResult public func on(
         _ path: String,
         method: HTTPRequest.Method,

diff --git a/Sources/Hummingbird/Router/RouterMethods.swift b/Sources/Hummingbird/Router/RouterMethods.swift
@@ -41,7 +41,7 @@ public protocol HBRouterMethods {
 }
 
 extension HBRouterMethods {
-    /// GET path for async closure returning type conforming to ResponseEncodable
+    /// GET path for async closure returning type conforming to HBResponseGenerator
     @discardableResult public func get(
         _ path: String = "",
         options: HBRouterMethodOptions = [],
@@ -50,7 +50,7 @@ extension HBRouterMethods {
         return on(path, method: .get, options: options, use: handler)
     }
 
-    /// PUT path for async closure returning type conforming to ResponseEncodable
+    /// PUT path for async closure returning type conforming to HBResponseGenerator
     @discardableResult public func put(
         _ path: String = "",
         options: HBRouterMethodOptions = [],
@@ -59,7 +59,7 @@ extension HBRouterMethods {
         return on(path, method: .put, options: options, use: handler)
     }
 
-    /// DELETE path for async closure returning type conforming to ResponseEncodable
+    /// DELETE path for async closure returning type conforming to HBResponseGenerator
     @discardableResult public func delete(
         _ path: String = "",
         options: HBRouterMethodOptions = [],
@@ -68,7 +68,7 @@ extension HBRouterMethods {
         return on(path, method: .delete, options: options, use: handler)
     }
 
-    /// HEAD path for async closure returning type conforming to ResponseEncodable
+    /// HEAD path for async closure returning type conforming to HBResponseGenerator
     @discardableResult public func head(
         _ path: String = "",
         options: HBRouterMethodOptions = [],
@@ -77,7 +77,7 @@ extension HBRouterMethods {
         return on(path, method: .head, options: options, use: handler)
     }
 
-    /// POST path for async closure returning type conforming to ResponseEncodable
+    /// POST path for async closure returning type conforming to HBResponseGenerator
     @discardableResult public func post(
         _ path: String = "",
         options: HBRouterMethodOptions = [],
@@ -86,7 +86,7 @@ extension HBRouterMethods {
         return on(path, method: .post, options: options, use: handler)
     }
 
-    /// PATCH path for async closure returning type conforming to ResponseEncodable
+    /// PATCH path for async closure returning type conforming to HBResponseGenerator
     @discardableResult public func patch(
         _ path: String = "",
         options: HBRouterMethodOptions = [],