wimax: fix typo in kernel-doc for debugfs_dentry in struct wimax_dev
authorInaky Perez-Gonzalez <inaky@linux.intel.com>
Fri, 9 Jan 2009 07:34:00 +0000 (07:34 +0000)
committerDavid S. Miller <davem@davemloft.net>
Sun, 11 Jan 2009 08:06:32 +0000 (00:06 -0800)
The kernel-doc was referring to member @debufs_dentry instead of
@debugfs_dentry.

Reported by Randy Dunlap http://marc.info/?l=linux-netdev&m=123147942302885&w=2

As well, escape the colon in the field's text description, as it is
causing the generated text to be erraticly broken up (with paragraphs
moved down). Could not find a reason why it is happening so, even when
other field descriptions use colons and work as expected.

Signed-off-by: Inaky Perez-Gonzalez <inaky@linux.intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
include/net/wimax.h

index 073809ce94f80f2ddf0163c90f13cd178e276748..6b3824edb39e027918b520b0ee031c9d442a44a0 100644 (file)
@@ -323,8 +323,8 @@ struct input_dev;
  *
  * @rf_hw: [private] State of the hardware radio switch (OFF/ON)
  *
- * @debufs_dentry: [private] Used to hook up a debugfs entry. This
- *     shows up in the debugfs root as wimax:DEVICENAME.
+ * @debugfs_dentry: [private] Used to hook up a debugfs entry. This
+ *     shows up in the debugfs root as wimax\:DEVICENAME.
  *
  * Description:
  * This structure defines a common interface to access all WiMAX