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>
This commit is contained in:
@@ -107,11 +107,11 @@ static int textual_leaf_to_string(const u32 *block, char *buf, size_t size)
|
||||
}
|
||||
|
||||
/**
|
||||
* fw_csr_string - reads a string from the configuration ROM
|
||||
* @directory: e.g. root directory or unit directory
|
||||
* @key: the key of the preceding directory entry
|
||||
* @buf: where to put the string
|
||||
* @size: size of @buf, in bytes
|
||||
* fw_csr_string() - reads a string from the configuration ROM
|
||||
* @directory: e.g. root directory or unit directory
|
||||
* @key: the key of the preceding directory entry
|
||||
* @buf: where to put the string
|
||||
* @size: size of @buf, in bytes
|
||||
*
|
||||
* The string is taken from a minimal ASCII text descriptor leaf after
|
||||
* the immediate entry with @key. The string is zero-terminated.
|
||||
|
||||
Reference in New Issue
Block a user