Giovanni Mascellani : include: Clarify docs for PFN_vkd3d_shader_close_include.

[Alexandre Julliard]

Module: vkd3d
Branch: master
Commit: 2a92fc1676269d9e2d251dd42f49992b562185d1
URL:    https://source.winehq.org/git/vkd3d.git/?a=commit;h=2a92fc1676269d9e2d251dd4...

Author: Giovanni Mascellani <gmascellani(a)codeweavers.com>
Date:   Thu Feb 24 09:20:14 2022 +0100

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(a)codeweavers.com>
Signed-off-by: Henri Verbeet <hverbeet(a)codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard(a)winehq.org>

---

 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 1eae0bb..5a60b37 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.