bios_table: pldm_bios_table_attr_entry_enum_encode_check() values
Document the pre-conditions that lead to failures and their associated
error codes.
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Id260f091d178aadc7ed2d2a667eb56a51d044bdc
diff --git a/include/libpldm/bios_table.h b/include/libpldm/bios_table.h
index 4fe45dd..09831f4 100644
--- a/include/libpldm/bios_table.h
+++ b/include/libpldm/bios_table.h
@@ -252,7 +252,10 @@
* @param[in] entry_length - Length of the buffer to create an entry
* @param[in] info - Pointer to an auxiliary structure @ref
* pldm_bios_table_attr_entry_enum_info
- * @return pldm_completion_codes
+ * @return PLDM_SUCCESS on success, otherwise PLDM_ERROR_INVALID_DATA if entry or info are NULL, or
+ * PLDM_ERROR_INVALID_LENGTH if entry_length is insufficient to encode info. An appropriate
+ * value for entry_length can be determined using @ref
+ * pldm_bios_table_attr_entry_enum_encode_length.
*/
int pldm_bios_table_attr_entry_enum_encode_check(
void *entry, size_t entry_length,