of: base: improve of_get_next_child() kernel-doc

Add two new facts to of_get_next_child() documentation:

   * of_get_next_child() returns NULL when there is not next child

   * of_get_next_child() decrements the refcount of prev

Signed-off-by: Baruch Siach <baruch@tkos.co.il>
Signed-off-by: Rob Herring <robh@kernel.org>
This commit is contained in:
Baruch Siach 2015-03-19 14:03:41 +02:00 committed by Rob Herring
parent 4155fc07fa
commit 6480827357
1 changed files with 3 additions and 2 deletions

View File

@ -663,8 +663,9 @@ static struct device_node *__of_get_next_child(const struct device_node *node,
* @node: parent node * @node: parent node
* @prev: previous child of the parent node, or NULL to get first * @prev: previous child of the parent node, or NULL to get first
* *
* Returns a node pointer with refcount incremented, use * Returns a node pointer with refcount incremented, use of_node_put() on
* of_node_put() on it when done. * it when done. Returns NULL when prev is the last child. Decrements the
* refcount of prev.
*/ */
struct device_node *of_get_next_child(const struct device_node *node, struct device_node *of_get_next_child(const struct device_node *node,
struct device_node *prev) struct device_node *prev)