[PATCH] D108525: Fix documentation and snippets for the handle attributes.

Aaron Ballman via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Mon Aug 23 05:21:15 PDT 2021


aaron.ballman added a comment.

Thank you for fixing up the docs! As long as we're here, I suggested some extra documentation wording to make it clear what the argument is and why it's used.



================
Comment at: clang/include/clang/Basic/AttrDocs.td:5884
 the function is assumed to fill the corresponding argument with a new
 handle.
 
----------------



================
Comment at: clang/include/clang/Basic/AttrDocs.td:5905
+parameter is annotated with ``use_handle(tag)`` it is assumed to not to change
 the state of the handle. It is also assumed to require an open handle to work with.
 
----------------



================
Comment at: clang/include/clang/Basic/AttrDocs.td:5919
+If a function parameter is annotated with ``release_handle(tag)`` it is assumed to
 close the handle. It is also assumed to require an open handle to work with.
 
----------------



Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D108525/new/

https://reviews.llvm.org/D108525



More information about the cfe-commits mailing list