[PATCH vkd3d] include: Clarify docs for PFN_vkd3d_shader_close_include.

Giovanni Mascellani gmascellani at codeweavers.com
Thu Feb 24 02:20:14 CST 2022


Clarify the contract about memory management of the code parameter
and reference callbacks by their name as fields of struct
vkd3d_shader_preprocess_info rather than by their type (like it
is already done above).

Signed-off-by: Giovanni Mascellani <gmascellani at codeweavers.com>
---
 include/vkd3d_shader.h | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/include/vkd3d_shader.h b/include/vkd3d_shader.h
index 1eae0bbe..5a60b374 100644
--- a/include/vkd3d_shader.h
+++ b/include/vkd3d_shader.h
@@ -787,8 +787,7 @@ typedef int (*PFN_vkd3d_shader_open_include)(const char *filename, bool local,
  * vkd3d_shader_preprocess_info.
  *
  * \param code Contents of the included file, which were allocated by the
- * \ref PFN_vkd3d_shader_open_include callback. The source code was allocated by
- * the user and thus need not be freed by vkd3d_shader_free_shader_code().
+ * \ref pfn_open_include callback. The user must free them.
  *
  * \param context The user-defined pointer passed to struct
  * vkd3d_shader_preprocess_info.
-- 
2.35.1




More information about the wine-devel mailing list