docs: add a few inline clarifications (#85)

Signed-off-by: Michael Rebello <[email protected]> Signed-off-by: JP Simard <[email protected]>
envoyproxy · Nov 28, 2022 · b2c1bb2 · b2c1bb2
1 parent 72abd17
commit b2c1bb2
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/mobile/examples/objective-c/hello_world/ViewController.mm b/mobile/examples/objective-c/hello_world/ViewController.mm
@@ -8,6 +8,7 @@
 
 #pragma mark - ResponseValue
 
+/// Represents a response from the server.
 @interface ResponseValue : NSObject
 @property (nonatomic, strong) NSString* body;
 @property (nonatomic, strong) NSString* serverHeader;
@@ -84,6 +85,7 @@ - (void)handleResponse:(NSHTTPURLResponse*)response data:(NSData*)data {
     return;
   }
 
+  // Deserialize the response, which will include a `Server` header set by Envoy.
   ResponseValue* value = [ResponseValue new];
   value.body = body;
   value.serverHeader = [[response allHeaderFields] valueForKey:@"Server"];

diff --git a/mobile/examples/swift/hello_world/ResponseValue.swift b/mobile/examples/swift/hello_world/ResponseValue.swift
@@ -1,3 +1,4 @@
+/// Represents a response from the server.
 struct Response {
   let body: String
   let serverHeader: String

diff --git a/mobile/examples/swift/hello_world/ViewController.swift b/mobile/examples/swift/hello_world/ViewController.swift
@@ -56,6 +56,7 @@ final class ViewController: UITableViewController {
 
     NSLog("Response:\n\(data.count) bytes\n\(body)\n\(headers)")
 
+    // Deserialize the response, which will include a `Server` header set by Envoy.
     let value = Response(body: body, serverHeader: headers["Server"] ?? "")
     DispatchQueue.main.async {
       self.responses.append(value)