pdr: pldm_is_current_parent_child(): Return false for invalid arguments
It can't be true that a node is a child of parent if either or both of
parent or node are NULL. Explicitly document this case.
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ibabaff24e12f3b53f87ecbcb127d84ab1e7773ba
diff --git a/include/libpldm/pdr.h b/include/libpldm/pdr.h
index 91b41de..25aa994 100644
--- a/include/libpldm/pdr.h
+++ b/include/libpldm/pdr.h
@@ -477,6 +477,9 @@
*
* @param[in] parent - opaque pointer acting as a handle to an entity parent
* @param[in] node - pointer to the node of the pldm entity
+ *
+ * @return True if the node is a child of parent, false otherwise, including if one or both of
+ * parent or node are NULL.
*/
bool pldm_is_current_parent_child(pldm_entity_node *parent, pldm_entity *node);