Messages in this thread | | | From | David Sterba <> | Subject | Re: [PATCH] ipwireless: driver for 3G PC Card | Date | Tue, 29 Jan 2008 14:42:08 +0100 |
| |
On Tuesday 29 of January 2008 00:18:03 Jiri Slaby wrote: > On 01/28/2008 07:08 PM, Randy Dunlap wrote: > >> +/* > >> + * @return 1 if something has been received from hw > > > > What's with the '@'? > > ... > > >> + > >> +/*! > > > > and the '!' ? > > > >> + * @return true if the card is physically present. > >> + */ > > What exactly is wrong with @ and !? It's perfectly doxygen-styled.
Well, I've removed them, this was not consistent neither within the driver nor with kernel documenting style.
> >> diff --git a/drivers/char/pcmcia/ipwireless/main.c > >> b/drivers/char/pcmcia/ipwireless/main.c new file mode 100644 > >> index 0000000..cab5722 > >> --- /dev/null > >> +++ b/drivers/char/pcmcia/ipwireless/main.c > >> @@ -0,0 +1,496 @@ > > [...] > > >> +module_param(major, int, 0); > >> +module_param(ipwireless_debug, int, 0); > >> +module_param(ipwireless_loopback, int, 0); > >> +module_param(ipwireless_out_queue, int, 0); > >> +MODULE_PARM_DESC(major, "ttyIPWp major number [0]"); > >> +MODULE_PARM_DESC(ipwireless_debug, "switch on debug messages [0]"); > >> +MODULE_PARM_DESC(ipwireless_debug, "switch on loopback mode [0]"); > >> +MODULE_PARM_DESC(ipwireless_debug, "set size of outgoing queue [1]"); > > > > Will these parameters be documented anywhere? > > Anyway the descs are wrong. Those 3 are for the only one variable.
Yes this was my copy&paste error, thanks.
Dave
| |