firewire: core: fix fw_send_request kerneldoc comment
authorStefan Richter <stefanr@s5r6.in-berlin.de>
Wed, 7 Jul 2010 11:26:18 +0000 (13:26 +0200)
committerStefan Richter <stefanr@s5r6.in-berlin.de>
Tue, 13 Jul 2010 07:47:47 +0000 (09:47 +0200)
commit656b7afd40a9f2b0d6cf8ef1972681961b428558
tree959bc229119224651799c2c1fce388a78cae08b8
parenta8e93f3dccc066cd6dd1e9db1e35942914fc57d1
firewire: core: fix fw_send_request kerneldoc comment

The present inline documentation of the fw_send_request() in-kernel API
refers to userland code that is not applicable to kernel drivers at all.

Reported-by: Ben Gamari <bgamari.foss@gmail.com>

While we are at fixing the whole documentation of fw_send_request(),
also improve the rest of firewire-core's kerneldoc comments:
  - Add a bit of text concerning fw_run_transaction()'s call parameters.
  - Append () to function names and tab-align parameter descriptions as
    suggested by the example in Documentation/kernel-doc-nano-HOWTO.txt.
  - Remove kerneldoc markers from comments on static functions.
  - Remove outdated parameter descriptions at build_tree().

Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>
drivers/firewire/core-device.c
drivers/firewire/core-iso.c
drivers/firewire/core-topology.c
drivers/firewire/core-transaction.c