Add some comments to description to netdev functions.
authorJustin Pettit <jpettit@nicira.com>
Tue, 23 Jun 2009 02:01:34 +0000 (19:01 -0700)
committerJustin Pettit <jpettit@nicira.com>
Tue, 23 Jun 2009 02:01:34 +0000 (19:01 -0700)
A few of the netdev functions lacked descriptions, so this adds them.

lib/netdev.c

index 8c14dd30cc269c48f601f2cb5de079473752504c..3d93e37e21d659316be5aaef7a5584c8bd7aa048 100644 (file)
@@ -729,6 +729,7 @@ netdev_get_features(struct netdev *netdev,
                            peer ? peer : &dummy[3]);
 }
 
+/* Set the features advertised by 'netdev' to 'advertise'. */
 int
 netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
 {
@@ -1113,6 +1114,8 @@ get_stats_via_proc(const char *netdev_name, struct netdev_stats *stats)
     return ENODEV;
 }
 
+/* Sets 'carrier' to true if carrier is active (link light is on) on 
+ * 'netdev'. */
 int
 netdev_get_carrier(const struct netdev *netdev, bool *carrier)
 {
@@ -1169,6 +1172,7 @@ exit:
     return error;
 }
 
+/* Retrieves current device stats for 'netdev'. */
 int
 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
 {