On 01/28/2008 07:08 PM, Randy Dunlap wrote:
quoted text
>> +/*
>> + * @return 1 if something has been received from hw
> 
> What's with the '@'?
...
quoted text
>> +
>> +/*!
> 
> and the '!' ?
> 
>> + * @return true if the card is physically present.
>> + */

What exactly is wrong with @ and !? It's perfectly doxygen-styled.

quoted text
>> 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 @@
[...]
quoted text
>> +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.

--
unsubscribe notice
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/