diff --git a/c/include/ml-api-common.h b/c/include/ml-api-common.h index f99a4a00..66b3a537 100644 --- a/c/include/ml-api-common.h +++ b/c/include/ml-api-common.h @@ -201,7 +201,7 @@ int ml_tensors_info_create_extended (ml_tensors_info_h *info); * @brief Frees the given handle of a tensors information. * @since_tizen 5.5 * @param[in] info The handle of tensors information. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. diff --git a/c/include/ml-api-service.h b/c/include/ml-api-service.h index 5cd336d0..d0029407 100644 --- a/c/include/ml-api-service.h +++ b/c/include/ml-api-service.h @@ -213,7 +213,7 @@ int ml_service_query_create (ml_option_h option, ml_service_h *handle); * @param[in] handle The query service handle created by ml_service_query_create(). * @param[in] input The handle of input tensors. * @param[out] output The handle of output tensors. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. @@ -235,7 +235,7 @@ int ml_service_query_request (ml_service_h handle, const ml_tensors_data_h input * @param[in] activate The flag to set the model to be activated. * @param[in] description Nullable, description for neural network model. * @param[out] version The version of registered model. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_PERMISSION_DENIED The application does not have the privilege to access to the storage. @@ -290,7 +290,7 @@ int ml_service_model_register (const char *name, const char *path, const bool ac * @param[in] name The unique name to indicate the model. * @param[in] version The version of registered model. * @param[in] description The description for neural network model. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. @@ -303,7 +303,7 @@ int ml_service_model_update_description (const char *name, const unsigned int ve * @since_tizen 8.0 * @param[in] name The unique name to indicate the model. * @param[in] version The version of registered model. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. @@ -318,7 +318,7 @@ int ml_service_model_activate (const char *name, const unsigned int version); * @param[in] name The unique name to indicate the model. * @param[in] version The version of registered model. * @param[out] info The handle of model information. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. @@ -333,7 +333,7 @@ int ml_service_model_get (const char *name, const unsigned int version, ml_infor * @remarks If the function succeeds, the @a info should be released using ml_information_destroy(). * @param[in] name The unique name to indicate the model. * @param[out] info The handle of activated model. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. @@ -348,7 +348,7 @@ int ml_service_model_get_activated (const char *name, ml_information_h *info); * @remarks If the function succeeds, the @a info_list should be released using ml_information_list_destroy(). * @param[in] name The unique name to indicate the model. * @param[out] info_list The handle of list of registered models. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. @@ -363,7 +363,7 @@ int ml_service_model_get_all (const char *name, ml_information_list_h *info_list * @remarks This does not remove the model file from file system. If @a version is 0, machine learning service will delete all information with given @a name. * @param[in] name The unique name to indicate the model. * @param[in] version The version of registered model. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. @@ -380,7 +380,7 @@ int ml_service_model_delete (const char *name, const unsigned int version); * @param[in] name The unique name to indicate the resources. * @param[in] path The path to machine learning resources. * @param[in] description Nullable, description for machine learning resources. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_PERMISSION_DENIED The application does not have the privilege to access to the storage. @@ -437,7 +437,7 @@ int ml_service_resource_add (const char *name, const char *path, const char *des * @since_tizen 8.0 * @remarks This does not remove the resource files from file system. * @param[in] name The unique name to indicate the resources. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. @@ -451,7 +451,7 @@ int ml_service_resource_delete (const char *name); * @remarks If the function succeeds, the @a res should be released using ml_information_list_destroy(). * @param[in] name The unique name to indicate the resources. * @param[out] res The handle of the machine learning resources. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. diff --git a/c/include/nnstreamer-tizen-internal.h b/c/include/nnstreamer-tizen-internal.h index 6e9a6d2d..d6dde97f 100644 --- a/c/include/nnstreamer-tizen-internal.h +++ b/c/include/nnstreamer-tizen-internal.h @@ -108,7 +108,7 @@ int ml_remote_service_create (ml_option_h option, ml_service_h *handle); * @param[in] handle The query service handle created by ml_service_query_create(). * @param[in] option The option used for registering machine learning service. * @param[in] data The Data to be registered on the remote server. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. diff --git a/c/include/nnstreamer.h b/c/include/nnstreamer.h index fa379e6d..35bbd8fe 100644 --- a/c/include/nnstreamer.h +++ b/c/include/nnstreamer.h @@ -313,7 +313,7 @@ int ml_pipeline_sink_unregister (ml_pipeline_sink_h sink_handle); * @param[in] pipe The pipeline to be attached with a src node. * @param[in] src_name The name of src node, described with ml_pipeline_construct(). * @param[out] src_handle The src handle. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. @@ -327,7 +327,7 @@ int ml_pipeline_src_get_handle (ml_pipeline_h pipe, const char *src_name, ml_pip * @brief Releases the given src handle. * @since_tizen 5.5 * @param[in] src_handle The src handle to be released. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. @@ -341,7 +341,7 @@ int ml_pipeline_src_release_handle (ml_pipeline_src_h src_handle); * @param[in] data The handle of input tensors, in the format of tensors info given by ml_pipeline_src_get_tensors_info(). * This function takes ownership of the data if @a policy is #ML_PIPELINE_BUF_POLICY_AUTO_FREE. * @param[in] policy The policy of buffer deallocation. The policy value may include buffer deallocation mechanisms or event triggers for appsrc elements. If event triggers are provided, these functions will not give input data to the appsrc element, but will trigger the given event only. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. @@ -368,7 +368,7 @@ typedef struct { * @param[in] src_handle The source handle returned by ml_pipeline_src_get_handle(). * @param[in] cb The app-src callbacks for event handling. * @param[in] user_data The user's custom data given to callbacks. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. @@ -383,7 +383,7 @@ int ml_pipeline_src_set_event_cb (ml_pipeline_src_h src_handle, ml_pipeline_src_ * @remarks If the function succeeds, @a info handle must be released using ml_tensors_info_destroy(). * @param[in] src_handle The source handle returned by ml_pipeline_src_get_handle(). * @param[out] info The handle of tensors information. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. @@ -406,7 +406,7 @@ int ml_pipeline_src_get_tensors_info (ml_pipeline_src_h src_handle, ml_tensors_i * @param[in] switch_name The name of switch (InputSelector/OutputSelector). * @param[out] switch_type The type of the switch. If NULL, it is ignored. * @param[out] switch_handle The switch handle. - * @return 0 on success. Otherwise a negative error value. + * @return @c 0 on success. Otherwise a negative error value. * @retval #ML_ERROR_NONE Successful. * @retval #ML_ERROR_NOT_SUPPORTED Not supported. * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid.