Address review feedback

Author: aarongreig

include/ur_api.h

@@ -743,21 +743,14 @@ urLoaderConfigSetCodeLocationCallback(
     void *pUserData                          ///< [in][out][optional] pointer to data to be passed to callback.
 );
 
-///////////////////////////////////////////////////////////////////////////////
-/// @brief Callback to replace or instrument generic mock functionality in the
-///        mock adapter.
-typedef ur_result_t (*ur_mock_callback_t)(
-    void *pParams ///< [in][out] Pointer to the appropriate param struct for the function
-);
-
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief The only adapter reported with mock enabled will be the mock adapter.
 ///
 /// @details
 ///     - The mock adapter will default to returning ::UR_RESULT_SUCCESS for all
 ///       entry points. It will also create and correctly reference count dummy
 ///       handles where appropriate. Its behaviour can be modified by linking
-///       the ::ur_mock_headers library and using the callbacks object.
+///       the ::ur_mock_headers library and using the mock::callbacks object.
 ///
 /// @returns
 ///     - ::UR_RESULT_SUCCESS

scripts/core/INTRO.rst

@@ -280,7 +280,7 @@ given entry point can only have one of each kind of callback associated with
 it, multiple structs with the same function/mode combination will override
 eachother.
 
-The callback signature defined by ``${x}_mock_callback_t`` takes a single
+The callback signature defined by ``ur_mock_callback_t`` takes a single
 ``void *`` parameter. When calling a user callback the layer will pack the
 entry point's parameters into the appropriate ``_params_t`` struct (e.g.
 ``ur_adapter_get_params_t``) and pass a pointer to that struct into the

scripts/core/loader.yml

@@ -1,3 +1,4 @@
+#
 # Copyright (C) 2022-2023 Intel Corporation
 #
 # Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM Exceptions.
@@ -186,19 +187,10 @@ params:
       name: pUserData
       desc: "[in][out][optional] pointer to data to be passed to callback."
 --- #--------------------------------------------------------------------------
-type: fptr_typedef
-desc: "Callback to replace or instrument generic mock functionality in the mock adapter."
-name: $x_mock_callback_t
-return: $x_result_t
-params:
-    - type: void*
-      name: pParams
-      desc: "[in][out] Pointer to the appropriate param struct for the function"
---- #--------------------------------------------------------------------------
 type: function
 desc: "The only adapter reported with mock enabled will be the mock adapter."
 details:
-    - "The mock adapter will default to returning $X_RESULT_SUCCESS for all entry points. It will also create and correctly reference count dummy handles where appropriate. Its behaviour can be modified by linking the $x_mock_headers library and using the callbacks object."
+    - "The mock adapter will default to returning $X_RESULT_SUCCESS for all entry points. It will also create and correctly reference count dummy handles where appropriate. Its behaviour can be modified by linking the $x_mock_headers library and using the mock::callbacks object."
 class: $xLoaderConfig
 loader_only: True
 name: "SetMockingEnabled"

source/loader/ur_libapi.cpp

@@ -199,7 +199,7 @@ ur_result_t UR_APICALL urLoaderConfigSetCodeLocationCallback(
 ///     - The mock adapter will default to returning ::UR_RESULT_SUCCESS for all
 ///       entry points. It will also create and correctly reference count dummy
 ///       handles where appropriate. Its behaviour can be modified by linking
-///       the ::ur_mock_headers library and using the callbacks object.
+///       the ::ur_mock_headers library and using the mock::callbacks object.
 ///
 /// @returns
 ///     - ::UR_RESULT_SUCCESS

source/mock/ur_mock_helpers.hpp

@@ -20,6 +20,11 @@
 #include <unordered_map>
 #include <vector>
 
+// This is the callback function we accept to override or instrument
+// entry-points. pParams is expected to be a pointer to the appropriate params_t
+// struct for the given entry point.
+typedef ur_result_t (*ur_mock_callback_t)(void *pParams);
+
 namespace mock {
 
 struct dummy_handle_t_ {

source/ur_api.cpp

@@ -188,7 +188,7 @@ ur_result_t UR_APICALL urLoaderConfigSetCodeLocationCallback(
 ///     - The mock adapter will default to returning ::UR_RESULT_SUCCESS for all
 ///       entry points. It will also create and correctly reference count dummy
 ///       handles where appropriate. Its behaviour can be modified by linking
-///       the ::ur_mock_headers library and using the callbacks object.
+///       the ::ur_mock_headers library and using the mock::callbacks object.
 ///
 /// @returns
 ///     - ::UR_RESULT_SUCCESS