Enhancement Comment of Specialized opaque context conversions

[avaneethkakkad]

Detailed function descriptions explaining purpose and usage

[github-actions]

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

[llvmbot]

@llvm/pr-subscribers-llvm-ir

Author: DarkM@LLVM (avaneethkakkad)

Changes

Detailed function descriptions explaining purpose and usage

---

Full diff: https://github.com/llvm/llvm-project/pull/158487.diff

1 Files Affected:

• (modified) llvm/include/llvm/IR/LLVMContext.h (+4-1)

diff --git a/llvm/include/llvm/IR/LLVMContext.h b/llvm/include/llvm/IR/LLVMContext.h
index 852a3a4e2f638..057e3231e6ccc 100644
--- a/llvm/include/llvm/IR/LLVMContext.h
+++ b/llvm/include/llvm/IR/LLVMContext.h
@@ -366,10 +366,13 @@ DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef)
 
 /* Specialized opaque context conversions.
  */
+//Converts an array of LLVMContextRef (C API opaque pointers) to 
+//an array of LLVMContext** (C++ object pointers).
 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
   return reinterpret_cast<LLVMContext**>(Tys);
 }
-
+//Converts an array of const LLVMContext** (C++ object pointers) to 
+//an array of LLVMContextRef (C API opaque pointers).
 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
   return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
 }