kset: kernel-doc cleanups
Randy Dunlap [Fri, 27 Jul 2007 16:36:26 +0000 (09:36 -0700)]
Removed kernel-doc marker (/**) from struct kset -- each struct member
still needs annotation.

Corrected one parameter name so that kernel-doc matches the macro.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>

include/linux/kobject.h

index 49a08f8..949706c 100644 (file)
@@ -111,9 +111,15 @@ struct kobj_type {
        struct attribute        ** default_attrs;
 };
 
+struct kset_uevent_ops {
+       int (*filter)(struct kset *kset, struct kobject *kobj);
+       const char *(*name)(struct kset *kset, struct kobject *kobj);
+       int (*uevent)(struct kset *kset, struct kobject *kobj, char **envp,
+                       int num_envp, char *buffer, int buffer_size);
+};
 
-/**
- *     kset - a set of kobjects of a specific type, belonging
+/*
+ *     struct kset - a set of kobjects of a specific type, belonging
  *     to a specific subsystem.
  *
  *     All kobjects of a kset should be embedded in an identical 
@@ -129,13 +135,6 @@ struct kobj_type {
  *     supress the event generation or add subsystem specific
  *     variables carried with the event.
  */
-struct kset_uevent_ops {
-       int (*filter)(struct kset *kset, struct kobject *kobj);
-       const char *(*name)(struct kset *kset, struct kobject *kobj);
-       int (*uevent)(struct kset *kset, struct kobject *kobj, char **envp,
-                       int num_envp, char *buffer, int buffer_size);
-};
-
 struct kset {
        struct kobj_type        * ktype;
        struct list_head        list;
@@ -176,7 +175,7 @@ static inline struct kobj_type * get_ktype(struct kobject * k)
 extern struct kobject * kset_find_obj(struct kset *, const char *);
 
 
-/**
+/*
  * Use this when initializing an embedded kset with no other 
  * fields to initialize.
  */
@@ -201,7 +200,7 @@ extern struct kset kernel_subsys;
 /* The global /sys/hypervisor/ subsystem  */
 extern struct kset hypervisor_subsys;
 
-/**
+/*
  * Helpers for setting the kset of registered objects.
  * Often, a registered object belongs to a kset embedded in a 
  * subsystem. These do no magic, just make the resulting code
@@ -236,7 +235,7 @@ extern struct kset hypervisor_subsys;
 /**
  *     subsys_set_kset(obj,subsys) - set kset for subsystem
  *     @obj:           ptr to some object type.
- *     @subsys:        a subsystem object (not a ptr).
+ *     @_subsys:       a subsystem object (not a ptr).
  *
  *     Can be used for any object type with an embedded ->subsys.
  *     Sets the kset of @obj's kobject to @subsys.kset. This makes