From: Rostislav Lisovy <lisovy@gmail.com>
Date: Fri, 11 May 2012 13:27:49 +0000 (+0200)
Subject: cls_can: Fixed comments style to proper kerneldoc
X-Git-Url: http://rtime.felk.cvut.cz/gitweb/lisovros/linux_canprio.git/commitdiff_plain/b34a38d52181464a4434c94b7d424b4d93901d79

cls_can: Fixed comments style to proper kerneldoc
---

diff --git a/net/sched/cls_can.c b/net/sched/cls_can.c
index cd0a0e8d973..1932b15532f 100644
--- a/net/sched/cls_can.c
+++ b/net/sched/cls_can.c
@@ -128,8 +128,8 @@ static void canfltr_sff_match_add(struct canfltr_rules *rls,
 #endif
 }
 
-/*
- * Extracts Can ID out of the sk_buff structure.
+/**
+ * canfltr_get_id() - Extracts Can ID out of the sk_buff structure.
  */
 static canid_t canfltr_get_id(struct sk_buff *skb)
 {
@@ -139,14 +139,15 @@ static canid_t canfltr_get_id(struct sk_buff *skb)
 	return cf->can_id;
 }
 
-/*
- * Performs the classification. Iterates over all instances of filter,
- * checking for CAN ID match.
+/**
+ * canfltr_classify() - Performs the classification.
  *
  * @skb: Socket buffer
  * @tp:
  * @res: Is used for setting Class ID as a result of classification
  *
+ * Iterates over all instances of filter, checking for CAN ID match.
+ *
  * Returns value relevant for policing. Used return values:
  *   TC_POLICE_OK if succesfully classified (without regard to policing rules)
  *   TC_POLICE_UNSPEC if no matching rule was found
@@ -205,9 +206,9 @@ static int canfltr_classify(struct sk_buff *skb, const struct tcf_proto *tp,
 	return TC_POLICE_UNSPEC;
 }
 
-/*
- * Looks up a filter element by its handle and returns the internal
- * filter ID (i.e. pointer)
+/**
+ * canfltr_get() - Looks up a filter element by its handle and returns the
+ * internal filter ID (i.e. pointer)
  */
 static unsigned long canfltr_get(struct tcf_proto *tp, u32 handle)
 {
@@ -225,8 +226,8 @@ static unsigned long canfltr_get(struct tcf_proto *tp, u32 handle)
 	return 0UL;
 }
 
-/*
- * Is invoked when a filter element previously referenced
+/**
+ * canfltr_put() - Is invoked when a filter element previously referenced
  * with get() is no longer used
  */
 static void canfltr_put(struct tcf_proto *tp, unsigned long f)
@@ -341,10 +342,10 @@ errout:
 	return err;
 }
 
-/*
- * Called for changing properties of an existing filter or after addition
- * of a new filter to a class (by calling bind_tcf which binds an instance
- * of a filter to the class).
+/**
+ * canfltr_change() - Called for changing properties of an existing filter or
+ * after addition of a new filter to a class (by calling bind_tcf which binds
+ * an instance of a filter to the class).
  *
  * @tp:     Structure representing instance of a filter.
  *          Part of a linked list of all filters.
@@ -430,8 +431,8 @@ static void canfltr_delete_filter(struct tcf_proto *tp,
 	kfree(f);
 }
 
-/*
- * Remove whole filter.
+/**
+ * canfltr_destroy() - Remove whole filter.
  */
 static void canfltr_destroy(struct tcf_proto *tp)
 {
@@ -445,8 +446,8 @@ static void canfltr_destroy(struct tcf_proto *tp)
 	kfree(head);
 }
 
-/*
- * Delete one instance of a filter.
+/**
+ * canfltr_delete() - Delete one instance of a filter.
  */
 static int canfltr_delete(struct tcf_proto *tp, unsigned long arg)
 {
@@ -469,8 +470,8 @@ static int canfltr_delete(struct tcf_proto *tp, unsigned long arg)
 }
 
 
-/*
- * Initialize filter
+/**
+ * canfltr_init() - Initialize filter
  */
 static int canfltr_init(struct tcf_proto *tp)
 {
@@ -493,9 +494,9 @@ static int canfltr_init(struct tcf_proto *tp)
 	return 0;
 }
 
-/*
- * Iterates over all elements of a filter and invokes a callback function
- * for each of them. This is used to obtain diagnostic data
+/**
+ * canfltr_walk() - Iterates over all elements of a filter and invokes a
+ * callback function for each of them. This is used to obtain diagnostic data.
  */
 static void canfltr_walk(struct tcf_proto *tp, struct tcf_walker *arg)
 {
@@ -515,8 +516,8 @@ skip:
 	}
 }
 
-/*
- * Returns diagnostic data for a filter or one of its elements.
+/**
+ * canfltr_dump() - Returns diagnostic data for a filter or one of its elements.
  */
 static int canfltr_dump(struct tcf_proto *tp, unsigned long fh,
 			struct sk_buff *skb, struct tcmsg *t)