diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2007-12-10 18:49:22 -0500 |
---|---|---|
committer | Linus Torvalds <torvalds@woody.linux-foundation.org> | 2007-12-10 22:43:54 -0500 |
commit | 78187865efa5aec5a28a200a39153f98d8f38d4d (patch) | |
tree | c1d998f95a59cf2089ff9cde2a011ea15142b0e3 | |
parent | 24601bbcacb3356657747f2e64317923feb7a1a2 (diff) |
pcmcia: fix kernel-doc comments
Fix kernel-doc comments in drivers/pcmcia/:
- ti113x.h does not contain kernel-doc, so don't use /** to begin a doc
comment
- yenta_socket.c: remove /** on non-kernel-doc comments;
escape the ':' in an "http:" comment so that it won't be treated as a
section heading;
- cs.c: remove /** on non-kernel-doc comments & add function parameter info
- ds.c: fix function parameter info
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
-rw-r--r-- | drivers/pcmcia/cs.c | 8 | ||||
-rw-r--r-- | drivers/pcmcia/ds.c | 6 | ||||
-rw-r--r-- | drivers/pcmcia/ti113x.h | 2 | ||||
-rw-r--r-- | drivers/pcmcia/yenta_socket.c | 6 |
4 files changed, 13 insertions, 9 deletions
diff --git a/drivers/pcmcia/cs.c b/drivers/pcmcia/cs.c index a0aca46ce877..56230dbd347a 100644 --- a/drivers/pcmcia/cs.c +++ b/drivers/pcmcia/cs.c | |||
@@ -89,7 +89,7 @@ DECLARE_RWSEM(pcmcia_socket_list_rwsem); | |||
89 | EXPORT_SYMBOL(pcmcia_socket_list_rwsem); | 89 | EXPORT_SYMBOL(pcmcia_socket_list_rwsem); |
90 | 90 | ||
91 | 91 | ||
92 | /** | 92 | /* |
93 | * Low-level PCMCIA socket drivers need to register with the PCCard | 93 | * Low-level PCMCIA socket drivers need to register with the PCCard |
94 | * core using pcmcia_register_socket. | 94 | * core using pcmcia_register_socket. |
95 | * | 95 | * |
@@ -174,6 +174,7 @@ static int pccardd(void *__skt); | |||
174 | 174 | ||
175 | /** | 175 | /** |
176 | * pcmcia_register_socket - add a new pcmcia socket device | 176 | * pcmcia_register_socket - add a new pcmcia socket device |
177 | * @socket: the &socket to register | ||
177 | */ | 178 | */ |
178 | int pcmcia_register_socket(struct pcmcia_socket *socket) | 179 | int pcmcia_register_socket(struct pcmcia_socket *socket) |
179 | { | 180 | { |
@@ -268,6 +269,7 @@ EXPORT_SYMBOL(pcmcia_register_socket); | |||
268 | 269 | ||
269 | /** | 270 | /** |
270 | * pcmcia_unregister_socket - remove a pcmcia socket device | 271 | * pcmcia_unregister_socket - remove a pcmcia socket device |
272 | * @socket: the &socket to unregister | ||
271 | */ | 273 | */ |
272 | void pcmcia_unregister_socket(struct pcmcia_socket *socket) | 274 | void pcmcia_unregister_socket(struct pcmcia_socket *socket) |
273 | { | 275 | { |
@@ -311,7 +313,7 @@ struct pcmcia_socket * pcmcia_get_socket_by_nr(unsigned int nr) | |||
311 | } | 313 | } |
312 | EXPORT_SYMBOL(pcmcia_get_socket_by_nr); | 314 | EXPORT_SYMBOL(pcmcia_get_socket_by_nr); |
313 | 315 | ||
314 | /** | 316 | /* |
315 | * The central event handler. Send_event() sends an event to the | 317 | * The central event handler. Send_event() sends an event to the |
316 | * 16-bit subsystem, which then calls the relevant device drivers. | 318 | * 16-bit subsystem, which then calls the relevant device drivers. |
317 | * Parse_events() interprets the event bits from | 319 | * Parse_events() interprets the event bits from |
@@ -380,7 +382,7 @@ static int socket_reset(struct pcmcia_socket *skt) | |||
380 | return CS_GENERAL_FAILURE; | 382 | return CS_GENERAL_FAILURE; |
381 | } | 383 | } |
382 | 384 | ||
383 | /** | 385 | /* |
384 | * socket_setup() and socket_shutdown() are called by the main event handler | 386 | * socket_setup() and socket_shutdown() are called by the main event handler |
385 | * when card insertion and removal events are received. | 387 | * when card insertion and removal events are received. |
386 | * socket_setup() turns on socket power and resets the socket, in two stages. | 388 | * socket_setup() turns on socket power and resets the socket, in two stages. |
diff --git a/drivers/pcmcia/ds.c b/drivers/pcmcia/ds.c index 7bf78c127898..5cf89a91da1e 100644 --- a/drivers/pcmcia/ds.c +++ b/drivers/pcmcia/ds.c | |||
@@ -320,6 +320,7 @@ pcmcia_create_newid_file(struct pcmcia_driver *drv) | |||
320 | 320 | ||
321 | /** | 321 | /** |
322 | * pcmcia_register_driver - register a PCMCIA driver with the bus core | 322 | * pcmcia_register_driver - register a PCMCIA driver with the bus core |
323 | * @driver: the &driver being registered | ||
323 | * | 324 | * |
324 | * Registers a PCMCIA driver with the PCMCIA bus core. | 325 | * Registers a PCMCIA driver with the PCMCIA bus core. |
325 | */ | 326 | */ |
@@ -354,6 +355,7 @@ EXPORT_SYMBOL(pcmcia_register_driver); | |||
354 | 355 | ||
355 | /** | 356 | /** |
356 | * pcmcia_unregister_driver - unregister a PCMCIA driver with the bus core | 357 | * pcmcia_unregister_driver - unregister a PCMCIA driver with the bus core |
358 | * @driver: the &driver being unregistered | ||
357 | */ | 359 | */ |
358 | void pcmcia_unregister_driver(struct pcmcia_driver *driver) | 360 | void pcmcia_unregister_driver(struct pcmcia_driver *driver) |
359 | { | 361 | { |
@@ -840,8 +842,8 @@ static void pcmcia_bus_rescan(struct pcmcia_socket *skt, int new_cis) | |||
840 | 842 | ||
841 | /** | 843 | /** |
842 | * pcmcia_load_firmware - load CIS from userspace if device-provided is broken | 844 | * pcmcia_load_firmware - load CIS from userspace if device-provided is broken |
843 | * @dev - the pcmcia device which needs a CIS override | 845 | * @dev: the pcmcia device which needs a CIS override |
844 | * @filename - requested filename in /lib/firmware/ | 846 | * @filename: requested filename in /lib/firmware/ |
845 | * | 847 | * |
846 | * This uses the in-kernel firmware loading mechanism to use a "fake CIS" if | 848 | * This uses the in-kernel firmware loading mechanism to use a "fake CIS" if |
847 | * the one provided by the card is broken. The firmware files reside in | 849 | * the one provided by the card is broken. The firmware files reside in |
diff --git a/drivers/pcmcia/ti113x.h b/drivers/pcmcia/ti113x.h index 62e9ebf967f9..d29657bf1b40 100644 --- a/drivers/pcmcia/ti113x.h +++ b/drivers/pcmcia/ti113x.h | |||
@@ -874,7 +874,7 @@ static int ti1250_override(struct yenta_socket *socket) | |||
874 | */ | 874 | */ |
875 | 875 | ||
876 | #ifdef CONFIG_YENTA_ENE_TUNE | 876 | #ifdef CONFIG_YENTA_ENE_TUNE |
877 | /** | 877 | /* |
878 | * set/clear various test bits: | 878 | * set/clear various test bits: |
879 | * Defaults to clear the bit. | 879 | * Defaults to clear the bit. |
880 | * - mask (u8) defines what bits to change | 880 | * - mask (u8) defines what bits to change |
diff --git a/drivers/pcmcia/yenta_socket.c b/drivers/pcmcia/yenta_socket.c index 20853a03202d..0ab1fb65cdc3 100644 --- a/drivers/pcmcia/yenta_socket.c +++ b/drivers/pcmcia/yenta_socket.c | |||
@@ -48,7 +48,7 @@ MODULE_PARM_DESC(pwr_irqs_off, "Force IRQs off during power-on of slot. Use only | |||
48 | #define to_cycles(ns) ((ns)/120) | 48 | #define to_cycles(ns) ((ns)/120) |
49 | #define to_ns(cycles) ((cycles)*120) | 49 | #define to_ns(cycles) ((cycles)*120) |
50 | 50 | ||
51 | /** | 51 | /* |
52 | * yenta PCI irq probing. | 52 | * yenta PCI irq probing. |
53 | * currently only used in the TI/EnE initialization code | 53 | * currently only used in the TI/EnE initialization code |
54 | */ | 54 | */ |
@@ -888,7 +888,7 @@ static unsigned int yenta_probe_irq(struct yenta_socket *socket, u32 isa_irq_mas | |||
888 | } | 888 | } |
889 | 889 | ||
890 | 890 | ||
891 | /** | 891 | /* |
892 | * yenta PCI irq probing. | 892 | * yenta PCI irq probing. |
893 | * currently only used in the TI/EnE initialization code | 893 | * currently only used in the TI/EnE initialization code |
894 | */ | 894 | */ |
@@ -1012,7 +1012,7 @@ static void yenta_config_init(struct yenta_socket *socket) | |||
1012 | * invisible during PCI scans because of a misconfigured subordinate number | 1012 | * invisible during PCI scans because of a misconfigured subordinate number |
1013 | * of the parent brige - some BIOSes seem to be too lazy to set it right. | 1013 | * of the parent brige - some BIOSes seem to be too lazy to set it right. |
1014 | * Does the fixup carefully by checking how far it can go without conflicts. | 1014 | * Does the fixup carefully by checking how far it can go without conflicts. |
1015 | * See http://bugzilla.kernel.org/show_bug.cgi?id=2944 for more information. | 1015 | * See http\://bugzilla.kernel.org/show_bug.cgi?id=2944 for more information. |
1016 | */ | 1016 | */ |
1017 | static void yenta_fixup_parent_bridge(struct pci_bus *cardbus_bridge) | 1017 | static void yenta_fixup_parent_bridge(struct pci_bus *cardbus_bridge) |
1018 | { | 1018 | { |