aboutsummaryrefslogtreecommitdiffhomepage
path: root/examples/objective-c
diff options
context:
space:
mode:
authorGravatar Jorge Canizales <jcanizales@google.com>2015-10-28 05:52:11 -0700
committerGravatar Jorge Canizales <jcanizales@google.com>2015-10-28 05:52:11 -0700
commit7fb5b3c2a06d95f03a63548ed498348904c1e27e (patch)
treeeff0a6652011f83d15b5511160f7703b1b1000d9 /examples/objective-c
parent8676d22b3d9ee2c69b50b360fa07a57d3753e82f (diff)
nit: Use appledoc-style documentation in the example
Diffstat (limited to 'examples/objective-c')
-rw-r--r--examples/objective-c/route_guide/ViewControllers.m34
1 files changed, 19 insertions, 15 deletions
diff --git a/examples/objective-c/route_guide/ViewControllers.m b/examples/objective-c/route_guide/ViewControllers.m
index 8332661d57..61367fdf85 100644
--- a/examples/objective-c/route_guide/ViewControllers.m
+++ b/examples/objective-c/route_guide/ViewControllers.m
@@ -38,7 +38,7 @@
static NSString * const kHostAddress = @"localhost:50051";
-// Category to override RTGPoint's description.
+/** Category to override RTGPoint's description. */
@interface RTGPoint (Description)
- (NSString *)description;
@end
@@ -53,7 +53,7 @@ static NSString * const kHostAddress = @"localhost:50051";
}
@end
-// Category to give RTGRouteNote a convenience constructor.
+/** Category to give RTGRouteNote a convenience constructor. */
@interface RTGRouteNote (Constructors)
+ (instancetype)noteWithMessage:(NSString *)message
latitude:(float)latitude
@@ -75,9 +75,10 @@ static NSString * const kHostAddress = @"localhost:50051";
#pragma mark Demo: Get Feature
-// Run the getFeature demo. Calls getFeature with a point known to have a feature and a point known
-// not to have a feature.
-
+/**
+ * Run the getFeature demo. Calls getFeature with a point known to have a feature and a point known
+ * not to have a feature.
+ */
@interface GetFeatureViewController : UIViewController
@end
@@ -114,9 +115,10 @@ static NSString * const kHostAddress = @"localhost:50051";
#pragma mark Demo: List Features
-// Run the listFeatures demo. Calls listFeatures with a rectangle containing all of the features in
-// the pre-generated database. Prints each response as it comes in.
-
+/**
+ * Run the listFeatures demo. Calls listFeatures with a rectangle containing all of the features in
+ * the pre-generated database. Prints each response as it comes in.
+ */
@interface ListFeaturesViewController : UIViewController
@end
@@ -149,10 +151,11 @@ static NSString * const kHostAddress = @"localhost:50051";
#pragma mark Demo: Record Route
-// Run the recordRoute demo. Sends several randomly chosen points from the pre-generated feature
-// database with a variable delay in between. Prints the statistics when they are sent from the
-// server.
-
+/**
+ * Run the recordRoute demo. Sends several randomly chosen points from the pre-generated feature
+ * database with a variable delay in between. Prints the statistics when they are sent from the
+ * server.
+ */
@interface RecordRouteViewController : UIViewController
@end
@@ -194,9 +197,10 @@ static NSString * const kHostAddress = @"localhost:50051";
#pragma mark Demo: Route Chat
-// Run the routeChat demo. Send some chat messages, and print any chat messages that are sent from
-// the server.
-
+/**
+ * Run the routeChat demo. Send some chat messages, and print any chat messages that are sent from
+ * the server.
+ */
@interface RouteChatViewController : UIViewController
@end