On Tue, Nov 14, 2006 at 10:18:06AM -0800, Randy Dunlap wrote:On Tue, 14 Nov 2006 17:50:51 +0530 Gautham R Shenoy wrote:
include/linux/notifier.h | 8 +++You can make that comment block be kernel-doc format by using
kernel/sys.c | 97 +++++++++++++++++++++++++++++++++++++++-------- 2 files changed, 89 insertions(+), 16 deletions(-)
Index: hotplug/kernel/sys.c
===================================================================
--- hotplug.orig/kernel/sys.c
+++ hotplug/kernel/sys.c
@@ -134,19 +134,41 @@ static int notifier_chain_unregister(str
return -ENOENT;
}
+/*
+ * notifier_call_chain - Informs the registered notifiers about an event.
+ *
+ * @nl: Pointer to head of the blocking notifier chain
+ * @val: Value passed unmodified to notifier function
+ * @v: Pointer passed unmodified to notifier function
+ * @nr_to_call: Number of notifier functions to be called. Don't care
+ * value of this parameter is -1.
+ * @nr_calls: Records the number of notifications sent. Don't care
+ * value of this field is NULL.
+ *
+ * RETURN VALUE: notifier_call_chain returns the value returned by the
+ * last notifier function called.
+ */
/**
as the comment introduction and removing the blank line after the
function name & short description.
Will do that. But out of curiousity, do the comments of even static functions
get reflected in kernel doc ? :?
static int __kprobes notifier_call_chain(struct notifier_block **nl,...
- unsigned long val, void *v)
+ unsigned long val, void *v,
+ int nr_to_call, unsigned int *nr_calls)
{
int ret = NOTIFY_DONE;
struct notifier_block *nb, *next_nb;
}