Re: [PATCH v2 0/11] MR103: DXBC handling API

[Giovanni Mascellani (＠giomasce)]

Giovanni Mascellani (@giomasce) commented about include/vkd3d_shader.h:
> -
> -
> -
> - \param flags A set of flags modifying the behaviour of the function. No
> -
> - flags are defined for this version of vkd3d-shader, and this parameter
> -
> - should be set to 0.
> -
> -
> -
> - \param desc A vkd3d_shader_dxbc_desc structure describing the contents of
> -
> - the DXBC blob. Its vkd3d_shader_dxbc_section_desc structures will contain
> -
> - pointers into the input blob; its contents are only valid while the input
> -
> - blob is valid. The contents of this structure should be freed with
> -
> - vkd3d_shader_free_dxbc() when no longer needed.
> -
> -
> -
> - \param messages Optional output location for error or informational messages
> -
> - produced by the parser.
> -
> - \n
> -
> - This parameter behaves identically to the \a messages parameter of
> -
> - vkd3d_shader_compile().

I don't like this too much. It behaves identically in what respect? Being NULL-terminated and UTF-8? Being regulated by `log_level`? I would just repeat the sentences that apply. It's a bit more verbose, but clearer, and you don't have to scroll to `vkd3d_shader_compile()` to understand the remark.