diff options
| author | Stefan Richter <stefanr@s5r6.in-berlin.de> | 2010-07-07 13:26:18 +0200 |
|---|---|---|
| committer | Stefan Richter <stefanr@s5r6.in-berlin.de> | 2010-07-13 09:47:47 +0200 |
| commit | 656b7afd40a9f2b0d6cf8ef1972681961b428558 (patch) | |
| tree | 959bc229119224651799c2c1fce388a78cae08b8 /drivers/firewire/core-topology.c | |
| parent | a8e93f3dccc066cd6dd1e9db1e35942914fc57d1 (diff) | |
| download | blackbird-op-linux-656b7afd40a9f2b0d6cf8ef1972681961b428558.tar.gz blackbird-op-linux-656b7afd40a9f2b0d6cf8ef1972681961b428558.zip | |
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>
Diffstat (limited to 'drivers/firewire/core-topology.c')
| -rw-r--r-- | drivers/firewire/core-topology.c | 16 |
1 files changed, 5 insertions, 11 deletions
diff --git a/drivers/firewire/core-topology.c b/drivers/firewire/core-topology.c index 88d5133ae702..09be1a635505 100644 --- a/drivers/firewire/core-topology.c +++ b/drivers/firewire/core-topology.c @@ -174,12 +174,7 @@ static inline struct fw_node *fw_node(struct list_head *l) return list_entry(l, struct fw_node, link); } -/** - * build_tree - Build the tree representation of the topology - * @self_ids: array of self IDs to create the tree from - * @self_id_count: the length of the self_ids array - * @local_id: the node ID of the local node - * +/* * This function builds the tree representation of the topology given * by the self IDs from the latest bus reset. During the construction * of the tree, the function checks that the self IDs are valid and @@ -420,11 +415,10 @@ static void move_tree(struct fw_node *node0, struct fw_node *node1, int port) } } -/** - * update_tree - compare the old topology tree for card with the new - * one specified by root. Queue the nodes and mark them as either - * found, lost or updated. Update the nodes in the card topology tree - * as we go. +/* + * Compare the old topology tree for card with the new one specified by root. + * Queue the nodes and mark them as either found, lost or updated. + * Update the nodes in the card topology tree as we go. */ static void update_tree(struct fw_card *card, struct fw_node *root) { |
