DomainKey-Signature: a=rsa-sha1; c=nofws;
        d=gmail.com; s=gamma;
        h=message-id:date:from:user-agent:mime-version:to:cc:subject:references:in-reply-to:x-enigmail-version:content-type:content-transfer-encoding;
        b=Hp08vdUBgVTPJ9lk+nyKrOhc2V8WdIFLnxHiO2HUQFkdZu/Hr64+K/3+77ZTMnAcEPkdGkikxFkwOwXqfQhggrHRWx5O5tTxRGpAY1m6jqQwxE0X/dWUsN4T6WEGzlzY5arrlU67WVBMGF7J2sqN1Zg7wukaD+Td7Rs/tqFYlVg=
Message-ID: <479E62AB.3010603@gmail.com>
Date: Tue, 29 Jan 2008 00:18:03 +0100
From: Jiri Slaby <jirislaby@gmail.com>
User-Agent: Thunderbird 2.0.0.9 (X11/20071031)
MIME-Version: 1.0
To: Randy Dunlap <rdunlap@xenotime.net>
CC: dsterba@suse.cz, torvalds@linux-foundation.org,
       linux-kernel@vger.kernel.org, jkosina@suse.cz, benm@symmetric.co.nz,
       stephen@symmetric.co.nz
Subject: Re: [PATCH] ipwireless: driver for 3G PC Card
References: <20080128171929.GA3906@ds.suse.cz> <20080128100854.fe7acad8.rdunlap@xenotime.net>
In-Reply-To: <20080128100854.fe7acad8.rdunlap@xenotime.net>
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 1350
Lines: 41

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.

>> 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.

--
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/