Skip to content

Commit 377c5c4

Browse files
committed
Improve documentation of memory allocation/deallocation API
1 parent f5772c9 commit 377c5c4

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

include/CppInterOp/CppInterOp.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -838,14 +838,14 @@ enum : long int {
838838
CPPINTEROP_API std::vector<long int> GetDimensions(TCppType_t type);
839839

840840
/// Allocates memory required by an object of a given class
841-
/// \c scope Given class for which to allocate memory for
842-
/// \c count is used to indicate the number of objects to allocate for.
841+
/// \param[in] scope Given class for which to allocate memory for
842+
/// \param[in] count is used to indicate the number of objects to allocate for.
843843
CPPINTEROP_API TCppObject_t Allocate(TCppScope_t scope,
844844
TCppIndex_t count = 1UL);
845845

846846
/// Deallocates memory for a given class.
847-
/// \c scope Class to indicate size of memory to deallocate
848-
/// \c count is used to indicate the number of objects to dallocate for
847+
/// \param[in] scope Class to indicate size of memory to deallocate
848+
/// \param[in] count is used to indicate the number of objects to dallocate for
849849
CPPINTEROP_API void Deallocate(TCppScope_t scope, TCppObject_t address,
850850
TCppIndex_t count = 1UL);
851851

@@ -855,6 +855,8 @@ CPPINTEROP_API void Deallocate(TCppScope_t scope, TCppObject_t address,
855855
/// \param[in] arena If set, this API uses placement new to construct at this
856856
/// address.
857857
/// \param[in] is used to indicate the number of objects to construct.
858+
/// \returns a pointer to the constructed object, which is arena if placement
859+
/// new is used.
858860
CPPINTEROP_API TCppObject_t Construct(TCppScope_t scope, void* arena = nullptr,
859861
TCppIndex_t count = 1UL);
860862

0 commit comments

Comments
 (0)