include: Clarify docs for PFN_vkd3d_shader_close_include.

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@codeweavers.com>
Signed-off-by: Henri Verbeet <hverbeet@codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard@winehq.org>
This commit is contained in:
Giovanni Mascellani 2022-02-24 09:20:14 +01:00 committed by Alexandre Julliard
parent 59d918fd50
commit 2a92fc1676

View File

@ -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.