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>
This commit is contained in:
Randy Dunlap 2007-12-10 15:49:22 -08:00 committed by Linus Torvalds
parent 24601bbcac
commit 78187865ef
4 changed files with 13 additions and 9 deletions

View File

@ -89,7 +89,7 @@ DECLARE_RWSEM(pcmcia_socket_list_rwsem);
EXPORT_SYMBOL(pcmcia_socket_list_rwsem); EXPORT_SYMBOL(pcmcia_socket_list_rwsem);
/** /*
* Low-level PCMCIA socket drivers need to register with the PCCard * Low-level PCMCIA socket drivers need to register with the PCCard
* core using pcmcia_register_socket. * core using pcmcia_register_socket.
* *
@ -174,6 +174,7 @@ static int pccardd(void *__skt);
/** /**
* pcmcia_register_socket - add a new pcmcia socket device * pcmcia_register_socket - add a new pcmcia socket device
* @socket: the &socket to register
*/ */
int pcmcia_register_socket(struct pcmcia_socket *socket) int pcmcia_register_socket(struct pcmcia_socket *socket)
{ {
@ -268,6 +269,7 @@ EXPORT_SYMBOL(pcmcia_register_socket);
/** /**
* pcmcia_unregister_socket - remove a pcmcia socket device * pcmcia_unregister_socket - remove a pcmcia socket device
* @socket: the &socket to unregister
*/ */
void pcmcia_unregister_socket(struct pcmcia_socket *socket) void pcmcia_unregister_socket(struct pcmcia_socket *socket)
{ {
@ -311,7 +313,7 @@ struct pcmcia_socket * pcmcia_get_socket_by_nr(unsigned int nr)
} }
EXPORT_SYMBOL(pcmcia_get_socket_by_nr); EXPORT_SYMBOL(pcmcia_get_socket_by_nr);
/** /*
* The central event handler. Send_event() sends an event to the * The central event handler. Send_event() sends an event to the
* 16-bit subsystem, which then calls the relevant device drivers. * 16-bit subsystem, which then calls the relevant device drivers.
* Parse_events() interprets the event bits from * Parse_events() interprets the event bits from
@ -380,7 +382,7 @@ static int socket_reset(struct pcmcia_socket *skt)
return CS_GENERAL_FAILURE; return CS_GENERAL_FAILURE;
} }
/** /*
* socket_setup() and socket_shutdown() are called by the main event handler * socket_setup() and socket_shutdown() are called by the main event handler
* when card insertion and removal events are received. * when card insertion and removal events are received.
* socket_setup() turns on socket power and resets the socket, in two stages. * socket_setup() turns on socket power and resets the socket, in two stages.

View File

@ -320,6 +320,7 @@ pcmcia_create_newid_file(struct pcmcia_driver *drv)
/** /**
* pcmcia_register_driver - register a PCMCIA driver with the bus core * pcmcia_register_driver - register a PCMCIA driver with the bus core
* @driver: the &driver being registered
* *
* Registers a PCMCIA driver with the PCMCIA bus core. * Registers a PCMCIA driver with the PCMCIA bus core.
*/ */
@ -354,6 +355,7 @@ EXPORT_SYMBOL(pcmcia_register_driver);
/** /**
* pcmcia_unregister_driver - unregister a PCMCIA driver with the bus core * pcmcia_unregister_driver - unregister a PCMCIA driver with the bus core
* @driver: the &driver being unregistered
*/ */
void pcmcia_unregister_driver(struct pcmcia_driver *driver) void pcmcia_unregister_driver(struct pcmcia_driver *driver)
{ {
@ -840,8 +842,8 @@ static void pcmcia_bus_rescan(struct pcmcia_socket *skt, int new_cis)
/** /**
* pcmcia_load_firmware - load CIS from userspace if device-provided is broken * pcmcia_load_firmware - load CIS from userspace if device-provided is broken
* @dev - the pcmcia device which needs a CIS override * @dev: the pcmcia device which needs a CIS override
* @filename - requested filename in /lib/firmware/ * @filename: requested filename in /lib/firmware/
* *
* This uses the in-kernel firmware loading mechanism to use a "fake CIS" if * This uses the in-kernel firmware loading mechanism to use a "fake CIS" if
* the one provided by the card is broken. The firmware files reside in * the one provided by the card is broken. The firmware files reside in

View File

@ -874,7 +874,7 @@ static int ti1250_override(struct yenta_socket *socket)
*/ */
#ifdef CONFIG_YENTA_ENE_TUNE #ifdef CONFIG_YENTA_ENE_TUNE
/** /*
* set/clear various test bits: * set/clear various test bits:
* Defaults to clear the bit. * Defaults to clear the bit.
* - mask (u8) defines what bits to change * - mask (u8) defines what bits to change

View File

@ -48,7 +48,7 @@ MODULE_PARM_DESC(pwr_irqs_off, "Force IRQs off during power-on of slot. Use only
#define to_cycles(ns) ((ns)/120) #define to_cycles(ns) ((ns)/120)
#define to_ns(cycles) ((cycles)*120) #define to_ns(cycles) ((cycles)*120)
/** /*
* yenta PCI irq probing. * yenta PCI irq probing.
* currently only used in the TI/EnE initialization code * currently only used in the TI/EnE initialization code
*/ */
@ -888,7 +888,7 @@ static unsigned int yenta_probe_irq(struct yenta_socket *socket, u32 isa_irq_mas
} }
/** /*
* yenta PCI irq probing. * yenta PCI irq probing.
* currently only used in the TI/EnE initialization code * currently only used in the TI/EnE initialization code
*/ */
@ -1012,7 +1012,7 @@ static void yenta_config_init(struct yenta_socket *socket)
* invisible during PCI scans because of a misconfigured subordinate number * invisible during PCI scans because of a misconfigured subordinate number
* of the parent brige - some BIOSes seem to be too lazy to set it right. * of the parent brige - some BIOSes seem to be too lazy to set it right.
* Does the fixup carefully by checking how far it can go without conflicts. * Does the fixup carefully by checking how far it can go without conflicts.
* See http://bugzilla.kernel.org/show_bug.cgi?id=2944 for more information. * See http\://bugzilla.kernel.org/show_bug.cgi?id=2944 for more information.
*/ */
static void yenta_fixup_parent_bridge(struct pci_bus *cardbus_bridge) static void yenta_fixup_parent_bridge(struct pci_bus *cardbus_bridge)
{ {