diff --git a/include/ur_api.h b/include/ur_api.h index c2f19f9ca2..3c3852dcc5 100644 --- a/include/ur_api.h +++ b/include/ur_api.h @@ -622,7 +622,7 @@ urLoaderConfigRetain( /// + `NULL == hLoaderConfig` UR_APIEXPORT ur_result_t UR_APICALL urLoaderConfigRelease( - ur_loader_config_handle_t hLoaderConfig ///< [in] config handle to release + ur_loader_config_handle_t hLoaderConfig ///< [in][release] config handle to release ); /////////////////////////////////////////////////////////////////////////////// @@ -845,7 +845,7 @@ urAdapterGet( /// + `NULL == hAdapter` UR_APIEXPORT ur_result_t UR_APICALL urAdapterRelease( - ur_adapter_handle_t hAdapter ///< [in] Adapter handle to release + ur_adapter_handle_t hAdapter ///< [in][release] Adapter handle to release ); /////////////////////////////////////////////////////////////////////////////// @@ -1764,7 +1764,7 @@ urDeviceRetain( /// + `NULL == hDevice` UR_APIEXPORT ur_result_t UR_APICALL urDeviceRelease( - ur_device_handle_t hDevice ///< [in] handle of the device to release. + ur_device_handle_t hDevice ///< [in][release] handle of the device to release. ); /////////////////////////////////////////////////////////////////////////////// @@ -2271,7 +2271,7 @@ typedef enum ur_context_info_t { /// + `NULL == hContext` UR_APIEXPORT ur_result_t UR_APICALL urContextRelease( - ur_context_handle_t hContext ///< [in] handle of the context to release. + ur_context_handle_t hContext ///< [in][release] handle of the context to release. ); /////////////////////////////////////////////////////////////////////////////// @@ -2761,7 +2761,7 @@ urMemRetain( /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY UR_APIEXPORT ur_result_t UR_APICALL urMemRelease( - ur_mem_handle_t hMem ///< [in] handle of the memory object to release + ur_mem_handle_t hMem ///< [in][release] handle of the memory object to release ); /////////////////////////////////////////////////////////////////////////////// @@ -3153,7 +3153,7 @@ urSamplerRetain( /// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES UR_APIEXPORT ur_result_t UR_APICALL urSamplerRelease( - ur_sampler_handle_t hSampler ///< [in] handle of the sampler object to release + ur_sampler_handle_t hSampler ///< [in][release] handle of the sampler object to release ); /////////////////////////////////////////////////////////////////////////////// @@ -3712,7 +3712,7 @@ urUSMPoolRetain( /// + `NULL == pPool` UR_APIEXPORT ur_result_t UR_APICALL urUSMPoolRelease( - ur_usm_pool_handle_t pPool ///< [in] pointer to USM memory pool + ur_usm_pool_handle_t pPool ///< [in][release] pointer to USM memory pool ); /////////////////////////////////////////////////////////////////////////////// @@ -4061,7 +4061,7 @@ urPhysicalMemRetain( /// + `NULL == hPhysicalMem` UR_APIEXPORT ur_result_t UR_APICALL urPhysicalMemRelease( - ur_physical_mem_handle_t hPhysicalMem ///< [in] handle of the physical memory object to release. + ur_physical_mem_handle_t hPhysicalMem ///< [in][release] handle of the physical memory object to release. ); #if !defined(__GNUC__) @@ -4354,7 +4354,7 @@ urProgramRetain( /// + `NULL == hProgram` UR_APIEXPORT ur_result_t UR_APICALL urProgramRelease( - ur_program_handle_t hProgram ///< [in] handle for the Program to release + ur_program_handle_t hProgram ///< [in][release] handle for the Program to release ); /////////////////////////////////////////////////////////////////////////////// @@ -5005,7 +5005,7 @@ urKernelRetain( /// + `NULL == hKernel` UR_APIEXPORT ur_result_t UR_APICALL urKernelRelease( - ur_kernel_handle_t hKernel ///< [in] handle for the Kernel to release + ur_kernel_handle_t hKernel ///< [in][release] handle for the Kernel to release ); /////////////////////////////////////////////////////////////////////////////// @@ -5516,7 +5516,7 @@ urQueueRetain( /// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES UR_APIEXPORT ur_result_t UR_APICALL urQueueRelease( - ur_queue_handle_t hQueue ///< [in] handle of the queue object to release + ur_queue_handle_t hQueue ///< [in][release] handle of the queue object to release ); /////////////////////////////////////////////////////////////////////////////// @@ -5905,7 +5905,7 @@ urEventRetain( /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY UR_APIEXPORT ur_result_t UR_APICALL urEventRelease( - ur_event_handle_t hEvent ///< [in] handle of the event object + ur_event_handle_t hEvent ///< [in][release] handle of the event object ); /////////////////////////////////////////////////////////////////////////////// @@ -7551,7 +7551,7 @@ UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesUnsampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object - ur_exp_image_handle_t hImage ///< [in] pointer to handle of image object to destroy + ur_exp_image_handle_t hImage ///< [in][release] pointer to handle of image object to destroy ); /////////////////////////////////////////////////////////////////////////////// @@ -7576,7 +7576,7 @@ UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesSampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object - ur_exp_image_handle_t hImage ///< [in] pointer to handle of image object to destroy + ur_exp_image_handle_t hImage ///< [in][release] pointer to handle of image object to destroy ); /////////////////////////////////////////////////////////////////////////////// @@ -7636,7 +7636,7 @@ UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesImageFreeExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object - ur_exp_image_mem_handle_t hImageMem ///< [in] handle of image memory to be freed + ur_exp_image_mem_handle_t hImageMem ///< [in][release] handle of image memory to be freed ); /////////////////////////////////////////////////////////////////////////////// @@ -7850,7 +7850,7 @@ UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesMipmapFreeExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object - ur_exp_image_mem_handle_t hMem ///< [in] handle of image memory to be freed + ur_exp_image_mem_handle_t hMem ///< [in][release] handle of image memory to be freed ); /////////////////////////////////////////////////////////////////////////////// @@ -7941,7 +7941,7 @@ UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesReleaseInteropExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object - ur_exp_interop_mem_handle_t hInteropMem ///< [in] handle of interop memory to be freed + ur_exp_interop_mem_handle_t hInteropMem ///< [in][release] handle of interop memory to be freed ); /////////////////////////////////////////////////////////////////////////////// @@ -7997,7 +7997,7 @@ UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesDestroyExternalSemaphoreExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object - ur_exp_interop_semaphore_handle_t hInteropSemaphore ///< [in] handle of interop semaphore to be destroyed + ur_exp_interop_semaphore_handle_t hInteropSemaphore ///< [in][release] handle of interop semaphore to be destroyed ); /////////////////////////////////////////////////////////////////////////////// @@ -8271,7 +8271,7 @@ urCommandBufferRetainExp( /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferReleaseExp( - ur_exp_command_buffer_handle_t hCommandBuffer ///< [in] Handle of the command-buffer object. + ur_exp_command_buffer_handle_t hCommandBuffer ///< [in][release] Handle of the command-buffer object. ); /////////////////////////////////////////////////////////////////////////////// @@ -8819,7 +8819,7 @@ urCommandBufferRetainCommandExp( /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferReleaseCommandExp( - ur_exp_command_buffer_command_handle_t hCommand ///< [in] Handle of the command-buffer command. + ur_exp_command_buffer_command_handle_t hCommand ///< [in][release] Handle of the command-buffer command. ); /////////////////////////////////////////////////////////////////////////////// diff --git a/scripts/YaML.md b/scripts/YaML.md index a995b5858c..089115cb1b 100644 --- a/scripts/YaML.md +++ b/scripts/YaML.md @@ -625,7 +625,7 @@ class ur_name_t(Structure): - `range` is used for params that are array pointers to specify the valid range that the is valid to read + `start` and `end` must be an ISO-C standard identifier or literal + `start` is inclusive and `end` is exclusive - - `release` is used for params that are handles or pointers to handles where the function will destroy any backing memory associated with the handle(s) + - `release` is used for params that are handles or pointers to handles where the function will decrement the handle's reference count, potentially leaving it in an invalid state if the reference count reaches zero. - `typename` is used to denote the type enum for params that are opaque pointers to values of tagged data types. - `bounds` is used for params that are memory objects or USM allocations. It specifies the range within the memory allocation represented by the param that will be accessed by the operation. + `offset` and `size` must be an ISO-C standard identifier or literal diff --git a/scripts/core/adapter.yml b/scripts/core/adapter.yml index a2331244e1..746c5b3a60 100644 --- a/scripts/core/adapter.yml +++ b/scripts/core/adapter.yml @@ -56,7 +56,7 @@ params: - type: "$x_adapter_handle_t" name: hAdapter desc: | - [in] Adapter handle to release + [in][release] Adapter handle to release --- #-------------------------------------------------------------------------- type: function desc: "Get a reference to the adapter handle." diff --git a/scripts/core/context.yml b/scripts/core/context.yml index fef1161fca..fdd57c7991 100644 --- a/scripts/core/context.yml +++ b/scripts/core/context.yml @@ -129,7 +129,7 @@ params: - type: "$x_context_handle_t" name: hContext desc: | - [in] handle of the context to release. + [in][release] handle of the context to release. --- #-------------------------------------------------------------------------- type: function desc: "Retrieves various information about context" diff --git a/scripts/core/device.yml b/scripts/core/device.yml index 713e7ac5ec..7249568954 100644 --- a/scripts/core/device.yml +++ b/scripts/core/device.yml @@ -524,7 +524,7 @@ params: - type: "$x_device_handle_t" name: hDevice desc: | - [in] handle of the device to release. + [in][release] handle of the device to release. --- #-------------------------------------------------------------------------- type: enum desc: "Device affinity domain" diff --git a/scripts/core/event.yml b/scripts/core/event.yml index 4e8be75cf4..6c80d1e9ee 100644 --- a/scripts/core/event.yml +++ b/scripts/core/event.yml @@ -246,7 +246,7 @@ analogue: params: - type: $x_event_handle_t name: hEvent - desc: "[in] handle of the event object" + desc: "[in][release] handle of the event object" returns: - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_OUT_OF_RESOURCES diff --git a/scripts/core/exp-bindless-images.yml b/scripts/core/exp-bindless-images.yml index f4e7b6fcd4..ece6fc8316 100644 --- a/scripts/core/exp-bindless-images.yml +++ b/scripts/core/exp-bindless-images.yml @@ -357,7 +357,7 @@ params: desc: "[in] handle of the device object" - type: $x_exp_image_handle_t name: hImage - desc: "[in] pointer to handle of image object to destroy" + desc: "[in][release] pointer to handle of image object to destroy" returns: - $X_RESULT_ERROR_INVALID_CONTEXT - $X_RESULT_ERROR_INVALID_VALUE @@ -378,7 +378,7 @@ params: desc: "[in] handle of the device object" - type: $x_exp_image_handle_t name: hImage - desc: "[in] pointer to handle of image object to destroy" + desc: "[in][release] pointer to handle of image object to destroy" returns: - $X_RESULT_ERROR_INVALID_CONTEXT - $X_RESULT_ERROR_INVALID_VALUE @@ -431,7 +431,7 @@ params: desc: "[in] handle of the device object" - type: $x_exp_image_mem_handle_t name: hImageMem - desc: "[in] handle of image memory to be freed" + desc: "[in][release] handle of image memory to be freed" returns: - $X_RESULT_ERROR_INVALID_CONTEXT - $X_RESULT_ERROR_INVALID_VALUE @@ -642,7 +642,7 @@ params: desc: "[in] handle of the device object" - type: $x_exp_image_mem_handle_t name: hMem - desc: "[in] handle of image memory to be freed" + desc: "[in][release] handle of image memory to be freed" returns: - $X_RESULT_ERROR_INVALID_CONTEXT - $X_RESULT_ERROR_INVALID_VALUE @@ -727,7 +727,7 @@ params: desc: "[in] handle of the device object" - type: $x_exp_interop_mem_handle_t name: hInteropMem - desc: "[in] handle of interop memory to be freed" + desc: "[in][release] handle of interop memory to be freed" returns: - $X_RESULT_ERROR_INVALID_CONTEXT - $X_RESULT_ERROR_INVALID_VALUE @@ -775,7 +775,7 @@ params: desc: "[in] handle of the device object" - type: $x_exp_interop_semaphore_handle_t name: hInteropSemaphore - desc: "[in] handle of interop semaphore to be destroyed" + desc: "[in][release] handle of interop semaphore to be destroyed" returns: - $X_RESULT_ERROR_INVALID_CONTEXT - $X_RESULT_ERROR_INVALID_VALUE diff --git a/scripts/core/exp-command-buffer.yml b/scripts/core/exp-command-buffer.yml index 6e276eac88..1276d1b617 100644 --- a/scripts/core/exp-command-buffer.yml +++ b/scripts/core/exp-command-buffer.yml @@ -265,7 +265,7 @@ name: ReleaseExp params: - type: $x_exp_command_buffer_handle_t name: hCommandBuffer - desc: "[in] Handle of the command-buffer object." + desc: "[in][release] Handle of the command-buffer object." returns: - $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP - $X_RESULT_ERROR_OUT_OF_RESOURCES @@ -893,7 +893,7 @@ name: ReleaseCommandExp params: - type: $x_exp_command_buffer_command_handle_t name: hCommand - desc: "[in] Handle of the command-buffer command." + desc: "[in][release] Handle of the command-buffer command." returns: - $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_COMMAND_HANDLE_EXP - $X_RESULT_ERROR_OUT_OF_RESOURCES diff --git a/scripts/core/kernel.yml b/scripts/core/kernel.yml index dda726c804..9604102741 100644 --- a/scripts/core/kernel.yml +++ b/scripts/core/kernel.yml @@ -309,7 +309,7 @@ details: params: - type: $x_kernel_handle_t name: hKernel - desc: "[in] handle for the Kernel to release" + desc: "[in][release] handle for the Kernel to release" --- #-------------------------------------------------------------------------- type: struct desc: "Properties for for $xKernelSetArgPointer." diff --git a/scripts/core/loader.yml b/scripts/core/loader.yml index b5ad1eadec..cd3d9931de 100644 --- a/scripts/core/loader.yml +++ b/scripts/core/loader.yml @@ -67,7 +67,7 @@ details: params: - type: $x_loader_config_handle_t name: hLoaderConfig - desc: "[in] config handle to release" + desc: "[in][release] config handle to release" --- #-------------------------------------------------------------------------- type: enum desc: "Supported loader info" diff --git a/scripts/core/memory.yml b/scripts/core/memory.yml index d0a46f46a7..3ec5fd4853 100644 --- a/scripts/core/memory.yml +++ b/scripts/core/memory.yml @@ -368,7 +368,7 @@ analogue: params: - type: $x_mem_handle_t name: hMem - desc: "[in] handle of the memory object to release" + desc: "[in][release] handle of the memory object to release" returns: - $X_RESULT_ERROR_INVALID_MEM_OBJECT - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY diff --git a/scripts/core/program.yml b/scripts/core/program.yml index 1cdb4e7b6b..816e4f8fd4 100644 --- a/scripts/core/program.yml +++ b/scripts/core/program.yml @@ -279,7 +279,7 @@ details: params: - type: $x_program_handle_t name: hProgram - desc: "[in] handle for the Program to release" + desc: "[in][release] handle for the Program to release" --- #-------------------------------------------------------------------------- type: function desc: "Retrieves a device function pointer to a user-defined function." diff --git a/scripts/core/queue.yml b/scripts/core/queue.yml index 27e8077ba2..2e64f72c06 100644 --- a/scripts/core/queue.yml +++ b/scripts/core/queue.yml @@ -204,7 +204,7 @@ details: params: - type: $x_queue_handle_t name: hQueue - desc: "[in] handle of the queue object to release" + desc: "[in][release] handle of the queue object to release" returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY diff --git a/scripts/core/sampler.yml b/scripts/core/sampler.yml index 7bb33b357e..a6649fa872 100644 --- a/scripts/core/sampler.yml +++ b/scripts/core/sampler.yml @@ -132,7 +132,7 @@ analogue: params: - type: $x_sampler_handle_t name: hSampler - desc: "[in] handle of the sampler object to release" + desc: "[in][release] handle of the sampler object to release" returns: - $X_RESULT_ERROR_INVALID_SAMPLER - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY diff --git a/scripts/core/usm.yml b/scripts/core/usm.yml index 7ba75bc865..29be62d7f5 100644 --- a/scripts/core/usm.yml +++ b/scripts/core/usm.yml @@ -449,7 +449,7 @@ details: params: - type: $x_usm_pool_handle_t name: pPool - desc: "[in] pointer to USM memory pool" + desc: "[in][release] pointer to USM memory pool" returns: - $X_RESULT_ERROR_INVALID_NULL_HANDLE --- #-------------------------------------------------------------------------- diff --git a/scripts/core/virtual_memory.yml b/scripts/core/virtual_memory.yml index ba88d4be2e..6433b7b91d 100644 --- a/scripts/core/virtual_memory.yml +++ b/scripts/core/virtual_memory.yml @@ -302,4 +302,4 @@ name: Release params: - type: $x_physical_mem_handle_t name: hPhysicalMem - desc: "[in] handle of the physical memory object to release." + desc: "[in][release] handle of the physical memory object to release." diff --git a/scripts/templates/ldrddi.cpp.mako b/scripts/templates/ldrddi.cpp.mako index 4da75d1f91..b93330049b 100644 --- a/scripts/templates/ldrddi.cpp.mako +++ b/scripts/templates/ldrddi.cpp.mako @@ -271,15 +271,17 @@ namespace ur_loader del add_local %> %for i, item in enumerate(epilogue): - %if 0 == i: + %if 0 == i and not item['release']: if( ${X}_RESULT_SUCCESS != result ) return result; %endif - %if item['release']: - // release loader handle - ${item['factory']}.release( ${item['name']} ); - %elif not '_native_object_' in item['obj']: + ## Before we can re-enable the releases we will need ref-counted object_t. + ## See unified-runtime github issue #1784 + ##%if item['release']: + ##// release loader handle + ##${item['factory']}.release( ${item['name']} ); + %if not item['release'] and not '_native_object_' in item['obj'] or th.make_func_name(n, tags, obj) == 'urPlatformCreateWithNativeHandle': try { %if 'typename' in item: diff --git a/source/adapters/null/ur_nullddi.cpp b/source/adapters/null/ur_nullddi.cpp index 4a686a9d59..93c7cab167 100644 --- a/source/adapters/null/ur_nullddi.cpp +++ b/source/adapters/null/ur_nullddi.cpp @@ -49,7 +49,7 @@ __urdlllocal ur_result_t UR_APICALL urAdapterGet( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urAdapterRelease __urdlllocal ur_result_t UR_APICALL urAdapterRelease( - ur_adapter_handle_t hAdapter ///< [in] Adapter handle to release + ur_adapter_handle_t hAdapter ///< [in][release] Adapter handle to release ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -450,7 +450,8 @@ __urdlllocal ur_result_t UR_APICALL urDeviceRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urDeviceRelease __urdlllocal ur_result_t UR_APICALL urDeviceRelease( - ur_device_handle_t hDevice ///< [in] handle of the device to release. + ur_device_handle_t + hDevice ///< [in][release] handle of the device to release. ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -663,7 +664,8 @@ __urdlllocal ur_result_t UR_APICALL urContextRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urContextRelease __urdlllocal ur_result_t UR_APICALL urContextRelease( - ur_context_handle_t hContext ///< [in] handle of the context to release. + ur_context_handle_t + hContext ///< [in][release] handle of the context to release. ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -886,7 +888,8 @@ __urdlllocal ur_result_t UR_APICALL urMemRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urMemRelease __urdlllocal ur_result_t UR_APICALL urMemRelease( - ur_mem_handle_t hMem ///< [in] handle of the memory object to release + ur_mem_handle_t + hMem ///< [in][release] handle of the memory object to release ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -1148,7 +1151,7 @@ __urdlllocal ur_result_t UR_APICALL urSamplerRetain( /// @brief Intercept function for urSamplerRelease __urdlllocal ur_result_t UR_APICALL urSamplerRelease( ur_sampler_handle_t - hSampler ///< [in] handle of the sampler object to release + hSampler ///< [in][release] handle of the sampler object to release ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -1469,7 +1472,7 @@ __urdlllocal ur_result_t UR_APICALL urUSMPoolRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urUSMPoolRelease __urdlllocal ur_result_t UR_APICALL urUSMPoolRelease( - ur_usm_pool_handle_t pPool ///< [in] pointer to USM memory pool + ur_usm_pool_handle_t pPool ///< [in][release] pointer to USM memory pool ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -1783,7 +1786,7 @@ __urdlllocal ur_result_t UR_APICALL urPhysicalMemRetain( /// @brief Intercept function for urPhysicalMemRelease __urdlllocal ur_result_t UR_APICALL urPhysicalMemRelease( ur_physical_mem_handle_t - hPhysicalMem ///< [in] handle of the physical memory object to release. + hPhysicalMem ///< [in][release] handle of the physical memory object to release. ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -1955,7 +1958,8 @@ __urdlllocal ur_result_t UR_APICALL urProgramRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urProgramRelease __urdlllocal ur_result_t UR_APICALL urProgramRelease( - ur_program_handle_t hProgram ///< [in] handle for the Program to release + ur_program_handle_t + hProgram ///< [in][release] handle for the Program to release ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -2422,7 +2426,8 @@ __urdlllocal ur_result_t UR_APICALL urKernelRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urKernelRelease __urdlllocal ur_result_t UR_APICALL urKernelRelease( - ur_kernel_handle_t hKernel ///< [in] handle for the Kernel to release + ur_kernel_handle_t + hKernel ///< [in][release] handle for the Kernel to release ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -2767,7 +2772,8 @@ __urdlllocal ur_result_t UR_APICALL urQueueRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urQueueRelease __urdlllocal ur_result_t UR_APICALL urQueueRelease( - ur_queue_handle_t hQueue ///< [in] handle of the queue object to release + ur_queue_handle_t + hQueue ///< [in][release] handle of the queue object to release ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -3006,7 +3012,7 @@ __urdlllocal ur_result_t UR_APICALL urEventRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urEventRelease __urdlllocal ur_result_t UR_APICALL urEventRelease( - ur_event_handle_t hEvent ///< [in] handle of the event object + ur_event_handle_t hEvent ///< [in][release] handle of the event object ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -4224,7 +4230,7 @@ urBindlessImagesUnsampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_handle_t - hImage ///< [in] pointer to handle of image object to destroy + hImage ///< [in][release] pointer to handle of image object to destroy ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -4250,7 +4256,7 @@ urBindlessImagesSampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_handle_t - hImage ///< [in] pointer to handle of image object to destroy + hImage ///< [in][release] pointer to handle of image object to destroy ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -4304,7 +4310,7 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesImageFreeExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_mem_handle_t - hImageMem ///< [in] handle of image memory to be freed + hImageMem ///< [in][release] handle of image memory to be freed ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -4500,9 +4506,10 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesMipmapGetLevelExp( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urBindlessImagesMipmapFreeExp __urdlllocal ur_result_t UR_APICALL urBindlessImagesMipmapFreeExp( - ur_context_handle_t hContext, ///< [in] handle of the context object - ur_device_handle_t hDevice, ///< [in] handle of the device object - ur_exp_image_mem_handle_t hMem ///< [in] handle of image memory to be freed + ur_context_handle_t hContext, ///< [in] handle of the context object + ur_device_handle_t hDevice, ///< [in] handle of the device object + ur_exp_image_mem_handle_t + hMem ///< [in][release] handle of image memory to be freed ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -4591,7 +4598,7 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesReleaseInteropExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_interop_mem_handle_t - hInteropMem ///< [in] handle of interop memory to be freed + hInteropMem ///< [in][release] handle of interop memory to be freed ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -4648,7 +4655,7 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesDestroyExternalSemaphoreExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_interop_semaphore_handle_t - hInteropSemaphore ///< [in] handle of interop semaphore to be destroyed + hInteropSemaphore ///< [in][release] handle of interop semaphore to be destroyed ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -4808,7 +4815,7 @@ __urdlllocal ur_result_t UR_APICALL urCommandBufferRetainExp( /// @brief Intercept function for urCommandBufferReleaseExp __urdlllocal ur_result_t UR_APICALL urCommandBufferReleaseExp( ur_exp_command_buffer_handle_t - hCommandBuffer ///< [in] Handle of the command-buffer object. + hCommandBuffer ///< [in][release] Handle of the command-buffer object. ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -5378,7 +5385,7 @@ __urdlllocal ur_result_t UR_APICALL urCommandBufferRetainCommandExp( /// @brief Intercept function for urCommandBufferReleaseCommandExp __urdlllocal ur_result_t UR_APICALL urCommandBufferReleaseCommandExp( ur_exp_command_buffer_command_handle_t - hCommand ///< [in] Handle of the command-buffer command. + hCommand ///< [in][release] Handle of the command-buffer command. ) try { ur_result_t result = UR_RESULT_SUCCESS; diff --git a/source/loader/layers/tracing/ur_trcddi.cpp b/source/loader/layers/tracing/ur_trcddi.cpp index cab7688e4f..a9b4bbf38d 100644 --- a/source/loader/layers/tracing/ur_trcddi.cpp +++ b/source/loader/layers/tracing/ur_trcddi.cpp @@ -57,7 +57,7 @@ __urdlllocal ur_result_t UR_APICALL urAdapterGet( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urAdapterRelease __urdlllocal ur_result_t UR_APICALL urAdapterRelease( - ur_adapter_handle_t hAdapter ///< [in] Adapter handle to release + ur_adapter_handle_t hAdapter ///< [in][release] Adapter handle to release ) { auto pfnAdapterRelease = context.urDdiTable.Global.pfnAdapterRelease; @@ -548,7 +548,8 @@ __urdlllocal ur_result_t UR_APICALL urDeviceRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urDeviceRelease __urdlllocal ur_result_t UR_APICALL urDeviceRelease( - ur_device_handle_t hDevice ///< [in] handle of the device to release. + ur_device_handle_t + hDevice ///< [in][release] handle of the device to release. ) { auto pfnRelease = context.urDdiTable.Device.pfnRelease; @@ -845,7 +846,8 @@ __urdlllocal ur_result_t UR_APICALL urContextRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urContextRelease __urdlllocal ur_result_t UR_APICALL urContextRelease( - ur_context_handle_t hContext ///< [in] handle of the context to release. + ur_context_handle_t + hContext ///< [in][release] handle of the context to release. ) { auto pfnRelease = context.urDdiTable.Context.pfnRelease; @@ -1139,7 +1141,8 @@ __urdlllocal ur_result_t UR_APICALL urMemRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urMemRelease __urdlllocal ur_result_t UR_APICALL urMemRelease( - ur_mem_handle_t hMem ///< [in] handle of the memory object to release + ur_mem_handle_t + hMem ///< [in][release] handle of the memory object to release ) { auto pfnRelease = context.urDdiTable.Mem.pfnRelease; @@ -1480,7 +1483,7 @@ __urdlllocal ur_result_t UR_APICALL urSamplerRetain( /// @brief Intercept function for urSamplerRelease __urdlllocal ur_result_t UR_APICALL urSamplerRelease( ur_sampler_handle_t - hSampler ///< [in] handle of the sampler object to release + hSampler ///< [in][release] handle of the sampler object to release ) { auto pfnRelease = context.urDdiTable.Sampler.pfnRelease; @@ -1879,7 +1882,7 @@ __urdlllocal ur_result_t UR_APICALL urUSMPoolRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urUSMPoolRelease __urdlllocal ur_result_t UR_APICALL urUSMPoolRelease( - ur_usm_pool_handle_t pPool ///< [in] pointer to USM memory pool + ur_usm_pool_handle_t pPool ///< [in][release] pointer to USM memory pool ) { auto pfnPoolRelease = context.urDdiTable.USM.pfnPoolRelease; @@ -2298,7 +2301,7 @@ __urdlllocal ur_result_t UR_APICALL urPhysicalMemRetain( /// @brief Intercept function for urPhysicalMemRelease __urdlllocal ur_result_t UR_APICALL urPhysicalMemRelease( ur_physical_mem_handle_t - hPhysicalMem ///< [in] handle of the physical memory object to release. + hPhysicalMem ///< [in][release] handle of the physical memory object to release. ) { auto pfnRelease = context.urDdiTable.PhysicalMem.pfnRelease; @@ -2543,7 +2546,8 @@ __urdlllocal ur_result_t UR_APICALL urProgramRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urProgramRelease __urdlllocal ur_result_t UR_APICALL urProgramRelease( - ur_program_handle_t hProgram ///< [in] handle for the Program to release + ur_program_handle_t + hProgram ///< [in][release] handle for the Program to release ) { auto pfnRelease = context.urDdiTable.Program.pfnRelease; @@ -3133,7 +3137,8 @@ __urdlllocal ur_result_t UR_APICALL urKernelRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urKernelRelease __urdlllocal ur_result_t UR_APICALL urKernelRelease( - ur_kernel_handle_t hKernel ///< [in] handle for the Kernel to release + ur_kernel_handle_t + hKernel ///< [in][release] handle for the Kernel to release ) { auto pfnRelease = context.urDdiTable.Kernel.pfnRelease; @@ -3583,7 +3588,8 @@ __urdlllocal ur_result_t UR_APICALL urQueueRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urQueueRelease __urdlllocal ur_result_t UR_APICALL urQueueRelease( - ur_queue_handle_t hQueue ///< [in] handle of the queue object to release + ur_queue_handle_t + hQueue ///< [in][release] handle of the queue object to release ) { auto pfnRelease = context.urDdiTable.Queue.pfnRelease; @@ -3891,7 +3897,7 @@ __urdlllocal ur_result_t UR_APICALL urEventRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urEventRelease __urdlllocal ur_result_t UR_APICALL urEventRelease( - ur_event_handle_t hEvent ///< [in] handle of the event object + ur_event_handle_t hEvent ///< [in][release] handle of the event object ) { auto pfnRelease = context.urDdiTable.Event.pfnRelease; @@ -5452,7 +5458,7 @@ urBindlessImagesUnsampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_handle_t - hImage ///< [in] pointer to handle of image object to destroy + hImage ///< [in][release] pointer to handle of image object to destroy ) { auto pfnUnsampledImageHandleDestroyExp = context.urDdiTable.BindlessImagesExp.pfnUnsampledImageHandleDestroyExp; @@ -5494,7 +5500,7 @@ urBindlessImagesSampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_handle_t - hImage ///< [in] pointer to handle of image object to destroy + hImage ///< [in][release] pointer to handle of image object to destroy ) { auto pfnSampledImageHandleDestroyExp = context.urDdiTable.BindlessImagesExp.pfnSampledImageHandleDestroyExp; @@ -5575,7 +5581,7 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesImageFreeExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_mem_handle_t - hImageMem ///< [in] handle of image memory to be freed + hImageMem ///< [in][release] handle of image memory to be freed ) { auto pfnImageFreeExp = context.urDdiTable.BindlessImagesExp.pfnImageFreeExp; @@ -5854,9 +5860,10 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesMipmapGetLevelExp( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urBindlessImagesMipmapFreeExp __urdlllocal ur_result_t UR_APICALL urBindlessImagesMipmapFreeExp( - ur_context_handle_t hContext, ///< [in] handle of the context object - ur_device_handle_t hDevice, ///< [in] handle of the device object - ur_exp_image_mem_handle_t hMem ///< [in] handle of image memory to be freed + ur_context_handle_t hContext, ///< [in] handle of the context object + ur_device_handle_t hDevice, ///< [in] handle of the device object + ur_exp_image_mem_handle_t + hMem ///< [in][release] handle of image memory to be freed ) { auto pfnMipmapFreeExp = context.urDdiTable.BindlessImagesExp.pfnMipmapFreeExp; @@ -5982,7 +5989,7 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesReleaseInteropExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_interop_mem_handle_t - hInteropMem ///< [in] handle of interop memory to be freed + hInteropMem ///< [in][release] handle of interop memory to be freed ) { auto pfnReleaseInteropExp = context.urDdiTable.BindlessImagesExp.pfnReleaseInteropExp; @@ -6065,7 +6072,7 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesDestroyExternalSemaphoreExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_interop_semaphore_handle_t - hInteropSemaphore ///< [in] handle of interop semaphore to be destroyed + hInteropSemaphore ///< [in][release] handle of interop semaphore to be destroyed ) { auto pfnDestroyExternalSemaphoreExp = context.urDdiTable.BindlessImagesExp.pfnDestroyExternalSemaphoreExp; @@ -6288,7 +6295,7 @@ __urdlllocal ur_result_t UR_APICALL urCommandBufferRetainExp( /// @brief Intercept function for urCommandBufferReleaseExp __urdlllocal ur_result_t UR_APICALL urCommandBufferReleaseExp( ur_exp_command_buffer_handle_t - hCommandBuffer ///< [in] Handle of the command-buffer object. + hCommandBuffer ///< [in][release] Handle of the command-buffer object. ) { auto pfnReleaseExp = context.urDdiTable.CommandBufferExp.pfnReleaseExp; @@ -7154,7 +7161,7 @@ __urdlllocal ur_result_t UR_APICALL urCommandBufferRetainCommandExp( /// @brief Intercept function for urCommandBufferReleaseCommandExp __urdlllocal ur_result_t UR_APICALL urCommandBufferReleaseCommandExp( ur_exp_command_buffer_command_handle_t - hCommand ///< [in] Handle of the command-buffer command. + hCommand ///< [in][release] Handle of the command-buffer command. ) { auto pfnReleaseCommandExp = context.urDdiTable.CommandBufferExp.pfnReleaseCommandExp; diff --git a/source/loader/layers/validation/ur_valddi.cpp b/source/loader/layers/validation/ur_valddi.cpp index 2af3e74497..72f3790816 100644 --- a/source/loader/layers/validation/ur_valddi.cpp +++ b/source/loader/layers/validation/ur_valddi.cpp @@ -53,7 +53,7 @@ __urdlllocal ur_result_t UR_APICALL urAdapterGet( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urAdapterRelease __urdlllocal ur_result_t UR_APICALL urAdapterRelease( - ur_adapter_handle_t hAdapter ///< [in] Adapter handle to release + ur_adapter_handle_t hAdapter ///< [in][release] Adapter handle to release ) { auto pfnAdapterRelease = context.urDdiTable.Global.pfnAdapterRelease; @@ -557,7 +557,8 @@ __urdlllocal ur_result_t UR_APICALL urDeviceRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urDeviceRelease __urdlllocal ur_result_t UR_APICALL urDeviceRelease( - ur_device_handle_t hDevice ///< [in] handle of the device to release. + ur_device_handle_t + hDevice ///< [in][release] handle of the device to release. ) { auto pfnRelease = context.urDdiTable.Device.pfnRelease; @@ -852,7 +853,8 @@ __urdlllocal ur_result_t UR_APICALL urContextRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urContextRelease __urdlllocal ur_result_t UR_APICALL urContextRelease( - ur_context_handle_t hContext ///< [in] handle of the context to release. + ur_context_handle_t + hContext ///< [in][release] handle of the context to release. ) { auto pfnRelease = context.urDdiTable.Context.pfnRelease; @@ -1223,7 +1225,8 @@ __urdlllocal ur_result_t UR_APICALL urMemRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urMemRelease __urdlllocal ur_result_t UR_APICALL urMemRelease( - ur_mem_handle_t hMem ///< [in] handle of the memory object to release + ur_mem_handle_t + hMem ///< [in][release] handle of the memory object to release ) { auto pfnRelease = context.urDdiTable.Mem.pfnRelease; @@ -1632,7 +1635,7 @@ __urdlllocal ur_result_t UR_APICALL urSamplerRetain( /// @brief Intercept function for urSamplerRelease __urdlllocal ur_result_t UR_APICALL urSamplerRelease( ur_sampler_handle_t - hSampler ///< [in] handle of the sampler object to release + hSampler ///< [in][release] handle of the sampler object to release ) { auto pfnRelease = context.urDdiTable.Sampler.pfnRelease; @@ -2127,7 +2130,7 @@ __urdlllocal ur_result_t UR_APICALL urUSMPoolRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urUSMPoolRelease __urdlllocal ur_result_t UR_APICALL urUSMPoolRelease( - ur_usm_pool_handle_t pPool ///< [in] pointer to USM memory pool + ur_usm_pool_handle_t pPool ///< [in][release] pointer to USM memory pool ) { auto pfnPoolRelease = context.urDdiTable.USM.pfnPoolRelease; @@ -2605,7 +2608,7 @@ __urdlllocal ur_result_t UR_APICALL urPhysicalMemRetain( /// @brief Intercept function for urPhysicalMemRelease __urdlllocal ur_result_t UR_APICALL urPhysicalMemRelease( ur_physical_mem_handle_t - hPhysicalMem ///< [in] handle of the physical memory object to release. + hPhysicalMem ///< [in][release] handle of the physical memory object to release. ) { auto pfnRelease = context.urDdiTable.PhysicalMem.pfnRelease; @@ -2910,7 +2913,8 @@ __urdlllocal ur_result_t UR_APICALL urProgramRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urProgramRelease __urdlllocal ur_result_t UR_APICALL urProgramRelease( - ur_program_handle_t hProgram ///< [in] handle for the Program to release + ur_program_handle_t + hProgram ///< [in][release] handle for the Program to release ) { auto pfnRelease = context.urDdiTable.Program.pfnRelease; @@ -3571,7 +3575,8 @@ __urdlllocal ur_result_t UR_APICALL urKernelRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urKernelRelease __urdlllocal ur_result_t UR_APICALL urKernelRelease( - ur_kernel_handle_t hKernel ///< [in] handle for the Kernel to release + ur_kernel_handle_t + hKernel ///< [in][release] handle for the Kernel to release ) { auto pfnRelease = context.urDdiTable.Kernel.pfnRelease; @@ -4092,7 +4097,8 @@ __urdlllocal ur_result_t UR_APICALL urQueueRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urQueueRelease __urdlllocal ur_result_t UR_APICALL urQueueRelease( - ur_queue_handle_t hQueue ///< [in] handle of the queue object to release + ur_queue_handle_t + hQueue ///< [in][release] handle of the queue object to release ) { auto pfnRelease = context.urDdiTable.Queue.pfnRelease; @@ -4410,7 +4416,7 @@ __urdlllocal ur_result_t UR_APICALL urEventRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urEventRelease __urdlllocal ur_result_t UR_APICALL urEventRelease( - ur_event_handle_t hEvent ///< [in] handle of the event object + ur_event_handle_t hEvent ///< [in][release] handle of the event object ) { auto pfnRelease = context.urDdiTable.Event.pfnRelease; @@ -6852,7 +6858,7 @@ urBindlessImagesUnsampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_handle_t - hImage ///< [in] pointer to handle of image object to destroy + hImage ///< [in][release] pointer to handle of image object to destroy ) { auto pfnUnsampledImageHandleDestroyExp = context.urDdiTable.BindlessImagesExp.pfnUnsampledImageHandleDestroyExp; @@ -6898,7 +6904,7 @@ urBindlessImagesSampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_handle_t - hImage ///< [in] pointer to handle of image object to destroy + hImage ///< [in][release] pointer to handle of image object to destroy ) { auto pfnSampledImageHandleDestroyExp = context.urDdiTable.BindlessImagesExp.pfnSampledImageHandleDestroyExp; @@ -7003,7 +7009,7 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesImageFreeExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_mem_handle_t - hImageMem ///< [in] handle of image memory to be freed + hImageMem ///< [in][release] handle of image memory to be freed ) { auto pfnImageFreeExp = context.urDdiTable.BindlessImagesExp.pfnImageFreeExp; @@ -7364,9 +7370,10 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesMipmapGetLevelExp( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urBindlessImagesMipmapFreeExp __urdlllocal ur_result_t UR_APICALL urBindlessImagesMipmapFreeExp( - ur_context_handle_t hContext, ///< [in] handle of the context object - ur_device_handle_t hDevice, ///< [in] handle of the device object - ur_exp_image_mem_handle_t hMem ///< [in] handle of image memory to be freed + ur_context_handle_t hContext, ///< [in] handle of the context object + ur_device_handle_t hDevice, ///< [in] handle of the device object + ur_exp_image_mem_handle_t + hMem ///< [in][release] handle of image memory to be freed ) { auto pfnMipmapFreeExp = context.urDdiTable.BindlessImagesExp.pfnMipmapFreeExp; @@ -7534,7 +7541,7 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesReleaseInteropExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_interop_mem_handle_t - hInteropMem ///< [in] handle of interop memory to be freed + hInteropMem ///< [in][release] handle of interop memory to be freed ) { auto pfnReleaseInteropExp = context.urDdiTable.BindlessImagesExp.pfnReleaseInteropExp; @@ -7637,7 +7644,7 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesDestroyExternalSemaphoreExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_interop_semaphore_handle_t - hInteropSemaphore ///< [in] handle of interop semaphore to be destroyed + hInteropSemaphore ///< [in][release] handle of interop semaphore to be destroyed ) { auto pfnDestroyExternalSemaphoreExp = context.urDdiTable.BindlessImagesExp.pfnDestroyExternalSemaphoreExp; @@ -7869,7 +7876,7 @@ __urdlllocal ur_result_t UR_APICALL urCommandBufferRetainExp( /// @brief Intercept function for urCommandBufferReleaseExp __urdlllocal ur_result_t UR_APICALL urCommandBufferReleaseExp( ur_exp_command_buffer_handle_t - hCommandBuffer ///< [in] Handle of the command-buffer object. + hCommandBuffer ///< [in][release] Handle of the command-buffer object. ) { auto pfnReleaseExp = context.urDdiTable.CommandBufferExp.pfnReleaseExp; @@ -8762,7 +8769,7 @@ __urdlllocal ur_result_t UR_APICALL urCommandBufferRetainCommandExp( /// @brief Intercept function for urCommandBufferReleaseCommandExp __urdlllocal ur_result_t UR_APICALL urCommandBufferReleaseCommandExp( ur_exp_command_buffer_command_handle_t - hCommand ///< [in] Handle of the command-buffer command. + hCommand ///< [in][release] Handle of the command-buffer command. ) { auto pfnReleaseCommandExp = context.urDdiTable.CommandBufferExp.pfnReleaseCommandExp; diff --git a/source/loader/ur_ldrddi.cpp b/source/loader/ur_ldrddi.cpp index f89edbd227..d064254461 100644 --- a/source/loader/ur_ldrddi.cpp +++ b/source/loader/ur_ldrddi.cpp @@ -84,7 +84,7 @@ __urdlllocal ur_result_t UR_APICALL urAdapterGet( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urAdapterRelease __urdlllocal ur_result_t UR_APICALL urAdapterRelease( - ur_adapter_handle_t hAdapter ///< [in] Adapter handle to release + ur_adapter_handle_t hAdapter ///< [in][release] Adapter handle to release ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -611,7 +611,8 @@ __urdlllocal ur_result_t UR_APICALL urDeviceRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urDeviceRelease __urdlllocal ur_result_t UR_APICALL urDeviceRelease( - ur_device_handle_t hDevice ///< [in] handle of the device to release. + ur_device_handle_t + hDevice ///< [in][release] handle of the device to release. ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -887,7 +888,8 @@ __urdlllocal ur_result_t UR_APICALL urContextRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urContextRelease __urdlllocal ur_result_t UR_APICALL urContextRelease( - ur_context_handle_t hContext ///< [in] handle of the context to release. + ur_context_handle_t + hContext ///< [in][release] handle of the context to release. ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -1191,7 +1193,8 @@ __urdlllocal ur_result_t UR_APICALL urMemRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urMemRelease __urdlllocal ur_result_t UR_APICALL urMemRelease( - ur_mem_handle_t hMem ///< [in] handle of the memory object to release + ur_mem_handle_t + hMem ///< [in][release] handle of the memory object to release ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -1549,7 +1552,7 @@ __urdlllocal ur_result_t UR_APICALL urSamplerRetain( /// @brief Intercept function for urSamplerRelease __urdlllocal ur_result_t UR_APICALL urSamplerRelease( ur_sampler_handle_t - hSampler ///< [in] handle of the sampler object to release + hSampler ///< [in][release] handle of the sampler object to release ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -1983,7 +1986,7 @@ __urdlllocal ur_result_t UR_APICALL urUSMPoolRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urUSMPoolRelease __urdlllocal ur_result_t UR_APICALL urUSMPoolRelease( - ur_usm_pool_handle_t pPool ///< [in] pointer to USM memory pool + ur_usm_pool_handle_t pPool ///< [in][release] pointer to USM memory pool ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -2371,7 +2374,7 @@ __urdlllocal ur_result_t UR_APICALL urPhysicalMemRetain( /// @brief Intercept function for urPhysicalMemRelease __urdlllocal ur_result_t UR_APICALL urPhysicalMemRelease( ur_physical_mem_handle_t - hPhysicalMem ///< [in] handle of the physical memory object to release. + hPhysicalMem ///< [in][release] handle of the physical memory object to release. ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -2616,7 +2619,8 @@ __urdlllocal ur_result_t UR_APICALL urProgramRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urProgramRelease __urdlllocal ur_result_t UR_APICALL urProgramRelease( - ur_program_handle_t hProgram ///< [in] handle for the Program to release + ur_program_handle_t + hProgram ///< [in][release] handle for the Program to release ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -3205,7 +3209,8 @@ __urdlllocal ur_result_t UR_APICALL urKernelRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urKernelRelease __urdlllocal ur_result_t UR_APICALL urKernelRelease( - ur_kernel_handle_t hKernel ///< [in] handle for the Kernel to release + ur_kernel_handle_t + hKernel ///< [in][release] handle for the Kernel to release ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -3650,7 +3655,8 @@ __urdlllocal ur_result_t UR_APICALL urQueueRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urQueueRelease __urdlllocal ur_result_t UR_APICALL urQueueRelease( - ur_queue_handle_t hQueue ///< [in] handle of the queue object to release + ur_queue_handle_t + hQueue ///< [in][release] handle of the queue object to release ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -3957,7 +3963,7 @@ __urdlllocal ur_result_t UR_APICALL urEventRetain( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urEventRelease __urdlllocal ur_result_t UR_APICALL urEventRelease( - ur_event_handle_t hEvent ///< [in] handle of the event object + ur_event_handle_t hEvent ///< [in][release] handle of the event object ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -5812,7 +5818,7 @@ urBindlessImagesUnsampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_handle_t - hImage ///< [in] pointer to handle of image object to destroy + hImage ///< [in][release] pointer to handle of image object to destroy ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -5846,7 +5852,7 @@ urBindlessImagesSampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_handle_t - hImage ///< [in] pointer to handle of image object to destroy + hImage ///< [in][release] pointer to handle of image object to destroy ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -5925,7 +5931,7 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesImageFreeExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_mem_handle_t - hImageMem ///< [in] handle of image memory to be freed + hImageMem ///< [in][release] handle of image memory to be freed ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -6219,9 +6225,10 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesMipmapGetLevelExp( /////////////////////////////////////////////////////////////////////////////// /// @brief Intercept function for urBindlessImagesMipmapFreeExp __urdlllocal ur_result_t UR_APICALL urBindlessImagesMipmapFreeExp( - ur_context_handle_t hContext, ///< [in] handle of the context object - ur_device_handle_t hDevice, ///< [in] handle of the device object - ur_exp_image_mem_handle_t hMem ///< [in] handle of image memory to be freed + ur_context_handle_t hContext, ///< [in] handle of the context object + ur_device_handle_t hDevice, ///< [in] handle of the device object + ur_exp_image_mem_handle_t + hMem ///< [in][release] handle of image memory to be freed ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -6353,7 +6360,7 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesReleaseInteropExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_interop_mem_handle_t - hInteropMem ///< [in] handle of interop memory to be freed + hInteropMem ///< [in][release] handle of interop memory to be freed ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -6437,7 +6444,7 @@ __urdlllocal ur_result_t UR_APICALL urBindlessImagesDestroyExternalSemaphoreExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_interop_semaphore_handle_t - hInteropSemaphore ///< [in] handle of interop semaphore to be destroyed + hInteropSemaphore ///< [in][release] handle of interop semaphore to be destroyed ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -6686,7 +6693,7 @@ __urdlllocal ur_result_t UR_APICALL urCommandBufferRetainExp( /// @brief Intercept function for urCommandBufferReleaseExp __urdlllocal ur_result_t UR_APICALL urCommandBufferReleaseExp( ur_exp_command_buffer_handle_t - hCommandBuffer ///< [in] Handle of the command-buffer object. + hCommandBuffer ///< [in][release] Handle of the command-buffer object. ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -7431,7 +7438,7 @@ __urdlllocal ur_result_t UR_APICALL urCommandBufferRetainCommandExp( /// @brief Intercept function for urCommandBufferReleaseCommandExp __urdlllocal ur_result_t UR_APICALL urCommandBufferReleaseCommandExp( ur_exp_command_buffer_command_handle_t - hCommand ///< [in] Handle of the command-buffer command. + hCommand ///< [in][release] Handle of the command-buffer command. ) { ur_result_t result = UR_RESULT_SUCCESS; diff --git a/source/loader/ur_libapi.cpp b/source/loader/ur_libapi.cpp index 67b266032e..dd72354f3a 100644 --- a/source/loader/ur_libapi.cpp +++ b/source/loader/ur_libapi.cpp @@ -76,7 +76,8 @@ ur_result_t UR_APICALL urLoaderConfigRetain( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hLoaderConfig` ur_result_t UR_APICALL urLoaderConfigRelease( - ur_loader_config_handle_t hLoaderConfig ///< [in] config handle to release + ur_loader_config_handle_t + hLoaderConfig ///< [in][release] config handle to release ) try { return ur_lib::urLoaderConfigRelease(hLoaderConfig); } catch (...) { @@ -313,7 +314,7 @@ ur_result_t UR_APICALL urAdapterGet( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hAdapter` ur_result_t UR_APICALL urAdapterRelease( - ur_adapter_handle_t hAdapter ///< [in] Adapter handle to release + ur_adapter_handle_t hAdapter ///< [in][release] Adapter handle to release ) try { auto pfnAdapterRelease = ur_lib::context->urDdiTable.Global.pfnAdapterRelease; @@ -947,7 +948,8 @@ ur_result_t UR_APICALL urDeviceRetain( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hDevice` ur_result_t UR_APICALL urDeviceRelease( - ur_device_handle_t hDevice ///< [in] handle of the device to release. + ur_device_handle_t + hDevice ///< [in][release] handle of the device to release. ) try { auto pfnRelease = ur_lib::context->urDdiTable.Device.pfnRelease; if (nullptr == pfnRelease) { @@ -1283,7 +1285,8 @@ ur_result_t UR_APICALL urContextRetain( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hContext` ur_result_t UR_APICALL urContextRelease( - ur_context_handle_t hContext ///< [in] handle of the context to release. + ur_context_handle_t + hContext ///< [in][release] handle of the context to release. ) try { auto pfnRelease = ur_lib::context->urDdiTable.Context.pfnRelease; if (nullptr == pfnRelease) { @@ -1648,7 +1651,8 @@ ur_result_t UR_APICALL urMemRetain( /// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY ur_result_t UR_APICALL urMemRelease( - ur_mem_handle_t hMem ///< [in] handle of the memory object to release + ur_mem_handle_t + hMem ///< [in][release] handle of the memory object to release ) try { auto pfnRelease = ur_lib::context->urDdiTable.Mem.pfnRelease; if (nullptr == pfnRelease) { @@ -2049,7 +2053,7 @@ ur_result_t UR_APICALL urSamplerRetain( /// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES ur_result_t UR_APICALL urSamplerRelease( ur_sampler_handle_t - hSampler ///< [in] handle of the sampler object to release + hSampler ///< [in][release] handle of the sampler object to release ) try { auto pfnRelease = ur_lib::context->urDdiTable.Sampler.pfnRelease; if (nullptr == pfnRelease) { @@ -2516,7 +2520,7 @@ ur_result_t UR_APICALL urUSMPoolRetain( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == pPool` ur_result_t UR_APICALL urUSMPoolRelease( - ur_usm_pool_handle_t pPool ///< [in] pointer to USM memory pool + ur_usm_pool_handle_t pPool ///< [in][release] pointer to USM memory pool ) try { auto pfnPoolRelease = ur_lib::context->urDdiTable.USM.pfnPoolRelease; if (nullptr == pfnPoolRelease) { @@ -2902,7 +2906,7 @@ ur_result_t UR_APICALL urPhysicalMemRetain( /// + `NULL == hPhysicalMem` ur_result_t UR_APICALL urPhysicalMemRelease( ur_physical_mem_handle_t - hPhysicalMem ///< [in] handle of the physical memory object to release. + hPhysicalMem ///< [in][release] handle of the physical memory object to release. ) try { auto pfnRelease = ur_lib::context->urDdiTable.PhysicalMem.pfnRelease; if (nullptr == pfnRelease) { @@ -3207,7 +3211,8 @@ ur_result_t UR_APICALL urProgramRetain( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hProgram` ur_result_t UR_APICALL urProgramRelease( - ur_program_handle_t hProgram ///< [in] handle for the Program to release + ur_program_handle_t + hProgram ///< [in][release] handle for the Program to release ) try { auto pfnRelease = ur_lib::context->urDdiTable.Program.pfnRelease; if (nullptr == pfnRelease) { @@ -3835,7 +3840,8 @@ ur_result_t UR_APICALL urKernelRetain( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hKernel` ur_result_t UR_APICALL urKernelRelease( - ur_kernel_handle_t hKernel ///< [in] handle for the Kernel to release + ur_kernel_handle_t + hKernel ///< [in][release] handle for the Kernel to release ) try { auto pfnRelease = ur_lib::context->urDdiTable.Kernel.pfnRelease; if (nullptr == pfnRelease) { @@ -4336,7 +4342,8 @@ ur_result_t UR_APICALL urQueueRetain( /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY /// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES ur_result_t UR_APICALL urQueueRelease( - ur_queue_handle_t hQueue ///< [in] handle of the queue object to release + ur_queue_handle_t + hQueue ///< [in][release] handle of the queue object to release ) try { auto pfnRelease = ur_lib::context->urDdiTable.Queue.pfnRelease; if (nullptr == pfnRelease) { @@ -4687,7 +4694,7 @@ ur_result_t UR_APICALL urEventRetain( /// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY ur_result_t UR_APICALL urEventRelease( - ur_event_handle_t hEvent ///< [in] handle of the event object + ur_event_handle_t hEvent ///< [in][release] handle of the event object ) try { auto pfnRelease = ur_lib::context->urDdiTable.Event.pfnRelease; if (nullptr == pfnRelease) { @@ -6537,7 +6544,7 @@ ur_result_t UR_APICALL urBindlessImagesUnsampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_handle_t - hImage ///< [in] pointer to handle of image object to destroy + hImage ///< [in][release] pointer to handle of image object to destroy ) try { auto pfnUnsampledImageHandleDestroyExp = ur_lib::context->urDdiTable.BindlessImagesExp @@ -6573,7 +6580,7 @@ ur_result_t UR_APICALL urBindlessImagesSampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_handle_t - hImage ///< [in] pointer to handle of image object to destroy + hImage ///< [in][release] pointer to handle of image object to destroy ) try { auto pfnSampledImageHandleDestroyExp = ur_lib::context->urDdiTable.BindlessImagesExp @@ -6656,7 +6663,7 @@ ur_result_t UR_APICALL urBindlessImagesImageFreeExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_mem_handle_t - hImageMem ///< [in] handle of image memory to be freed + hImageMem ///< [in][release] handle of image memory to be freed ) try { auto pfnImageFreeExp = ur_lib::context->urDdiTable.BindlessImagesExp.pfnImageFreeExp; @@ -6945,9 +6952,10 @@ ur_result_t UR_APICALL urBindlessImagesMipmapGetLevelExp( /// - ::UR_RESULT_ERROR_INVALID_CONTEXT /// - ::UR_RESULT_ERROR_INVALID_VALUE ur_result_t UR_APICALL urBindlessImagesMipmapFreeExp( - ur_context_handle_t hContext, ///< [in] handle of the context object - ur_device_handle_t hDevice, ///< [in] handle of the device object - ur_exp_image_mem_handle_t hMem ///< [in] handle of image memory to be freed + ur_context_handle_t hContext, ///< [in] handle of the context object + ur_device_handle_t hDevice, ///< [in] handle of the device object + ur_exp_image_mem_handle_t + hMem ///< [in][release] handle of image memory to be freed ) try { auto pfnMipmapFreeExp = ur_lib::context->urDdiTable.BindlessImagesExp.pfnMipmapFreeExp; @@ -7075,7 +7083,7 @@ ur_result_t UR_APICALL urBindlessImagesReleaseInteropExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_interop_mem_handle_t - hInteropMem ///< [in] handle of interop memory to be freed + hInteropMem ///< [in][release] handle of interop memory to be freed ) try { auto pfnReleaseInteropExp = ur_lib::context->urDdiTable.BindlessImagesExp.pfnReleaseInteropExp; @@ -7156,7 +7164,7 @@ ur_result_t UR_APICALL urBindlessImagesDestroyExternalSemaphoreExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_interop_semaphore_handle_t - hInteropSemaphore ///< [in] handle of interop semaphore to be destroyed + hInteropSemaphore ///< [in][release] handle of interop semaphore to be destroyed ) try { auto pfnDestroyExternalSemaphoreExp = ur_lib::context->urDdiTable.BindlessImagesExp @@ -7360,7 +7368,7 @@ ur_result_t UR_APICALL urCommandBufferRetainExp( /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY ur_result_t UR_APICALL urCommandBufferReleaseExp( ur_exp_command_buffer_handle_t - hCommandBuffer ///< [in] Handle of the command-buffer object. + hCommandBuffer ///< [in][release] Handle of the command-buffer object. ) try { auto pfnReleaseExp = ur_lib::context->urDdiTable.CommandBufferExp.pfnReleaseExp; @@ -8160,7 +8168,7 @@ ur_result_t UR_APICALL urCommandBufferRetainCommandExp( /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY ur_result_t UR_APICALL urCommandBufferReleaseCommandExp( ur_exp_command_buffer_command_handle_t - hCommand ///< [in] Handle of the command-buffer command. + hCommand ///< [in][release] Handle of the command-buffer command. ) try { auto pfnReleaseCommandExp = ur_lib::context->urDdiTable.CommandBufferExp.pfnReleaseCommandExp; diff --git a/source/ur_api.cpp b/source/ur_api.cpp index d591bee906..1457bab8d3 100644 --- a/source/ur_api.cpp +++ b/source/ur_api.cpp @@ -71,7 +71,8 @@ ur_result_t UR_APICALL urLoaderConfigRetain( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hLoaderConfig` ur_result_t UR_APICALL urLoaderConfigRelease( - ur_loader_config_handle_t hLoaderConfig ///< [in] config handle to release + ur_loader_config_handle_t + hLoaderConfig ///< [in][release] config handle to release ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -284,7 +285,7 @@ ur_result_t UR_APICALL urAdapterGet( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hAdapter` ur_result_t UR_APICALL urAdapterRelease( - ur_adapter_handle_t hAdapter ///< [in] Adapter handle to release + ur_adapter_handle_t hAdapter ///< [in][release] Adapter handle to release ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -828,7 +829,8 @@ ur_result_t UR_APICALL urDeviceRetain( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hDevice` ur_result_t UR_APICALL urDeviceRelease( - ur_device_handle_t hDevice ///< [in] handle of the device to release. + ur_device_handle_t + hDevice ///< [in][release] handle of the device to release. ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -1111,7 +1113,8 @@ ur_result_t UR_APICALL urContextRetain( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hContext` ur_result_t UR_APICALL urContextRelease( - ur_context_handle_t hContext ///< [in] handle of the context to release. + ur_context_handle_t + hContext ///< [in][release] handle of the context to release. ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -1423,7 +1426,8 @@ ur_result_t UR_APICALL urMemRetain( /// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY ur_result_t UR_APICALL urMemRelease( - ur_mem_handle_t hMem ///< [in] handle of the memory object to release + ur_mem_handle_t + hMem ///< [in][release] handle of the memory object to release ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -1763,7 +1767,7 @@ ur_result_t UR_APICALL urSamplerRetain( /// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES ur_result_t UR_APICALL urSamplerRelease( ur_sampler_handle_t - hSampler ///< [in] handle of the sampler object to release + hSampler ///< [in][release] handle of the sampler object to release ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -2159,7 +2163,7 @@ ur_result_t UR_APICALL urUSMPoolRetain( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == pPool` ur_result_t UR_APICALL urUSMPoolRelease( - ur_usm_pool_handle_t pPool ///< [in] pointer to USM memory pool + ur_usm_pool_handle_t pPool ///< [in][release] pointer to USM memory pool ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -2476,7 +2480,7 @@ ur_result_t UR_APICALL urPhysicalMemRetain( /// + `NULL == hPhysicalMem` ur_result_t UR_APICALL urPhysicalMemRelease( ur_physical_mem_handle_t - hPhysicalMem ///< [in] handle of the physical memory object to release. + hPhysicalMem ///< [in][release] handle of the physical memory object to release. ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -2737,7 +2741,8 @@ ur_result_t UR_APICALL urProgramRetain( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hProgram` ur_result_t UR_APICALL urProgramRelease( - ur_program_handle_t hProgram ///< [in] handle for the Program to release + ur_program_handle_t + hProgram ///< [in][release] handle for the Program to release ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -3262,7 +3267,8 @@ ur_result_t UR_APICALL urKernelRetain( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hKernel` ur_result_t UR_APICALL urKernelRelease( - ur_kernel_handle_t hKernel ///< [in] handle for the Kernel to release + ur_kernel_handle_t + hKernel ///< [in][release] handle for the Kernel to release ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -3684,7 +3690,8 @@ ur_result_t UR_APICALL urQueueRetain( /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY /// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES ur_result_t UR_APICALL urQueueRelease( - ur_queue_handle_t hQueue ///< [in] handle of the queue object to release + ur_queue_handle_t + hQueue ///< [in][release] handle of the queue object to release ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -3976,7 +3983,7 @@ ur_result_t UR_APICALL urEventRetain( /// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY ur_result_t UR_APICALL urEventRelease( - ur_event_handle_t hEvent ///< [in] handle of the event object + ur_event_handle_t hEvent ///< [in][release] handle of the event object ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -5590,7 +5597,7 @@ ur_result_t UR_APICALL urBindlessImagesUnsampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_handle_t - hImage ///< [in] pointer to handle of image object to destroy + hImage ///< [in][release] pointer to handle of image object to destroy ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -5618,7 +5625,7 @@ ur_result_t UR_APICALL urBindlessImagesSampledImageHandleDestroyExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_handle_t - hImage ///< [in] pointer to handle of image object to destroy + hImage ///< [in][release] pointer to handle of image object to destroy ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -5685,7 +5692,7 @@ ur_result_t UR_APICALL urBindlessImagesImageFreeExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_image_mem_handle_t - hImageMem ///< [in] handle of image memory to be freed + hImageMem ///< [in][release] handle of image memory to be freed ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -5925,9 +5932,10 @@ ur_result_t UR_APICALL urBindlessImagesMipmapGetLevelExp( /// - ::UR_RESULT_ERROR_INVALID_CONTEXT /// - ::UR_RESULT_ERROR_INVALID_VALUE ur_result_t UR_APICALL urBindlessImagesMipmapFreeExp( - ur_context_handle_t hContext, ///< [in] handle of the context object - ur_device_handle_t hDevice, ///< [in] handle of the device object - ur_exp_image_mem_handle_t hMem ///< [in] handle of image memory to be freed + ur_context_handle_t hContext, ///< [in] handle of the context object + ur_device_handle_t hDevice, ///< [in] handle of the device object + ur_exp_image_mem_handle_t + hMem ///< [in][release] handle of image memory to be freed ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -6031,7 +6039,7 @@ ur_result_t UR_APICALL urBindlessImagesReleaseInteropExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_interop_mem_handle_t - hInteropMem ///< [in] handle of interop memory to be freed + hInteropMem ///< [in][release] handle of interop memory to be freed ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -6095,7 +6103,7 @@ ur_result_t UR_APICALL urBindlessImagesDestroyExternalSemaphoreExp( ur_context_handle_t hContext, ///< [in] handle of the context object ur_device_handle_t hDevice, ///< [in] handle of the device object ur_exp_interop_semaphore_handle_t - hInteropSemaphore ///< [in] handle of interop semaphore to be destroyed + hInteropSemaphore ///< [in][release] handle of interop semaphore to be destroyed ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -6257,7 +6265,7 @@ ur_result_t UR_APICALL urCommandBufferRetainExp( /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY ur_result_t UR_APICALL urCommandBufferReleaseExp( ur_exp_command_buffer_handle_t - hCommandBuffer ///< [in] Handle of the command-buffer object. + hCommandBuffer ///< [in][release] Handle of the command-buffer object. ) { ur_result_t result = UR_RESULT_SUCCESS; return result; @@ -6913,7 +6921,7 @@ ur_result_t UR_APICALL urCommandBufferRetainCommandExp( /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY ur_result_t UR_APICALL urCommandBufferReleaseCommandExp( ur_exp_command_buffer_command_handle_t - hCommand ///< [in] Handle of the command-buffer command. + hCommand ///< [in][release] Handle of the command-buffer command. ) { ur_result_t result = UR_RESULT_SUCCESS; return result;