pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments
Also identify the conditions in the doxygen commentary in the public
header.
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I37945ab559ffdee5648b2d9ea2befc9fc9a24a9c
diff --git a/include/libpldm/pdr.h b/include/libpldm/pdr.h
index b05085f..413ef7a 100644
--- a/include/libpldm/pdr.h
+++ b/include/libpldm/pdr.h
@@ -547,6 +547,8 @@
/** @brief Extract entities from entity association PDR
*
+ * @pre `*entities == NULL` and `*num_entities == 0` must hold at the time of invocation.
+ *
* @param[in] pdr - entity association PDR
* @param[in] pdr_len - size of entity association PDR in bytes
* @param[out] num_entities - number of entities found, including the container