IntenseWebs/openvino
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[C API] some contents missed in doxygen (#17671)

Browse Source 
* remove @param and separate line

* separate line of ov_remote_context_free

* fix code style

* Update src/bindings/c/include/openvino/c/ov_remote_context.h

Co-authored-by: Chen Peter <peter.chen@intel.com>

* add ...

* add ...

---------

Co-authored-by: Chen Peter <peter.chen@intel.com>
This commit is contained in:
Haiqi Pan
2023-06-01 10:22:08 +08:00
committed by GitHub
parent e45068bd64
commit 2dd0b75529
3 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/bindings/c/include/openvino/c/ov_core.h
View File

@@ -199,7 +199,7 @@ ov_core_read_model_from_memory(const ov_core_t* core,
* @param device_name Name of a device to load a model to.
* @param property_args_size How many properties args will be passed, each property contains 2 args: key and value.
* @param compiled_model A pointer to the newly created compiled_model.
* @param property paramater: Optional pack of pairs: <char* property_key, char* property_value> relevant only
* @param ... property paramater: Optional pack of pairs: <char* property_key, char* property_value> relevant only
* for this load operation operation. Supported property key please see ov_property.h.
* @return Status code of the operation: OK(0) for success.
*/
@@ -338,7 +338,8 @@ ov_core_get_versions_by_device_name(const ov_core_t* core, const char* device_na
* @ingroup ov_core_c_api
* @param versions A pointer to the ie_core_versions to free memory.
*/
OPENVINO_C_API(void) ov_core_versions_free(ov_core_version_list_t* versions);
OPENVINO_C_API(void)
ov_core_versions_free(ov_core_version_list_t* versions);
/**
* @brief Creates a new remote shared context object on the specified accelerator device
@@ -348,7 +349,7 @@ OPENVINO_C_API(void) ov_core_versions_free(ov_core_version_list_t* versions);
* @param device_name Device name to identify a plugin.
* @param context_args_size How many property args will be for this remote context creation.
* @param context A pointer to the newly created remote context.
* @param variadic parmameters Actual context property parameter for remote context
* @param ... variadic parmameters Actual context property parameter for remote context
* @return Status code of the operation: OK(0) for success.
*/
OPENVINO_C_API(ov_status_e)
@@ -366,7 +367,7 @@ ov_core_create_context(const ov_core_t* core,
* @param context A pointer to the newly created remote context.
* @param property_args_size How many args will be for this compiled model.
* @param compiled_model A pointer to the newly created compiled_model.
* @param variadic parmameters Actual property parameter for remote context
* @param ... variadic parmameters Actual property parameter for remote context
* @return Status code of the operation: OK(0) for success.
*/
OPENVINO_C_API(ov_status_e)

2
src/bindings/c/include/openvino/c/ov_prepostprocess.h
View File

@@ -293,7 +293,7 @@ ov_preprocess_input_tensor_info_set_color_format(ov_preprocess_input_tensor_info
* @param preprocess_input_tensor_info A pointer to the ov_preprocess_input_tensor_info_t.
* @param colorFormat The enumerate of colorFormat
* @param sub_names_size The size of sub_names
* @param variadic params sub_names Optional list of sub-names assigned for each plane (e.g. "Y", "UV").
* @param ... variadic params sub_names Optional list of sub-names assigned for each plane (e.g. "Y", "UV").
* @return Status code of the operation: OK(0) for success.
*/
OPENVINO_C_API(ov_status_e)

5
src/bindings/c/include/openvino/c/ov_remote_context.h
View File

@@ -25,7 +25,7 @@ typedef struct ov_remote_context ov_remote_context_t;
* @param shape Defines the shape of the tensor.
* @param object_args_size Size of the low-level tensor object parameters.
* @param remote_tensor Pointer to returned ov_tensor_t that contains remote tensor instance.
* @param variadic params Contains low-level tensor object parameters.
* @param ... variadic params Contains low-level tensor object parameters.
* @return Status code of the operation: OK(0) for success.
*/
OPENVINO_C_API(ov_status_e)
@@ -85,7 +85,8 @@ ov_remote_context_create_host_tensor(const ov_remote_context_t* context,
* @param context A pointer to the ov_remote_context_t to free memory.
* @return Status code of the operation: OK(0) for success.
*/
OPENVINO_C_API(void) ov_remote_context_free(ov_remote_context_t* context);
OPENVINO_C_API(void)
ov_remote_context_free(ov_remote_context_t* context);
/**
* @brief Returns a string contains device-specific parameters required for low-level