Skip to content
Snippets Groups Projects

vkd3d-shader: Make documentation for "messages" parameters self contained.

Merged Giovanni Mascellani requested to merge giomasce/vkd3d:amiata into master
1 unresolved thread

Otherwise it's not clear which clauses in vkd3d_shader_compile() really apply to other functions. For example, many of the functions currently refering to vkd3d_shader_compile() don't even take a vkd3d_shader_compile_info parameter.

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Elizabeth Figura approved this merge request

    approved this merge request

    • @@ -1934,10 +1967,15 @@ VKD3D_SHADER_API void vkd3d_shader_free_dxbc(struct vkd3d_shader_dxbc_desc *dxbc
        * vkd3d_shader_free_dxbc() when no longer needed.
        *
        * \param messages Optional output location for error or informational messages
      - * produced by the parser.
      + * produced by the compiler.
        * \n
      - * This parameter behaves identically to the \a messages parameter of
      - * vkd3d_shader_compile().
      + * This string is null-terminated and UTF-8 encoded.
      + * \n
      + * The messages are allocated by vkd3d-shader and should be freed with
      + * vkd3d_shader_free_messages() when no longer needed.
      + * \n
      + * If no compilation messages are produced by the compiler, this parameter may
      + * receive NULL instead of a valid string pointer.
        *
        * \return A member of \ref vkd3d_result.
        *

      This is the comment for vkd3d_shader_parse_dxbc(), though there are similar issues with the other functions. References like "produced by the compiler", and "compilation messages" seem somewhat out of place. I suppose "the compiler" could be interpreted as vkd3d-shader in general, but in that case we might as well replace it with just "vkd3d-shader".

    • Right, I fixed them. I also fixed a few other comments that were sort of inconsistent in the same way. And also changed "serialis-" to "serializ-", mostly choosing the "z" version because it's what's being used in the function names. It's also the version closer to the original Greek suffix, so I hope it will make @zfigura happier.

    • Please register or sign in to reply
  • added 1 commit

    • 9b87ad51 - vkd3d-shader: Make documentation for "messages" parameters self contained.

    Compare with previous version

  • added 1 commit

    • 5a788a5d - vkd3d-shader: Make documentation for "messages" parameters self contained.

    Compare with previous version

  • And also changed "serialis-" to "serializ-", mostly choosing the "z" version because it's what's being used in the function names. It's also the version closer to the original Greek suffix, so I hope it will make @zfigura happier.

    Well, I grew up in Europe, so I was thought the proper -ise spelling. The spelling of vkd3d_shader_serialize_dxbc() was mostly dictated by the rather unfortunate precedent set by vkd3d_shader_serialize_root_signature(). ;)

  • Henri Verbeet approved this merge request

    approved this merge request

  • added 9 commits

    • 5a788a5d...a28ecaa1 - 8 commits from branch wine:master
    • 6ccde9e8 - vkd3d-shader: Make documentation for "messages" parameters self contained.

    Compare with previous version

  • Alexandre Julliard approved this merge request

    approved this merge request

Please register or sign in to reply
Loading