From: 오형석/On-Device Lab(SR)/Staff Engineer/삼성전자 Date: Wed, 4 Dec 2019 05:48:29 +0000 (+0900) Subject: [runtime/api] Fix doxygen format (#9368) X-Git-Tag: submit/tizen/20191205.083104~20 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ad257dba4908143a98273647fd02bebee2dbac26;p=platform%2Fcore%2Fml%2Fnnfw.git [runtime/api] Fix doxygen format (#9368) - Add file description - Move or remove note tag - Disable autolink: autolink makes invalid link to class because of same class name (ex. Tensor) Signed-off-by: Hyeongseok Oh --- diff --git a/infra/doxygen/Doxyfile b/infra/doxygen/Doxyfile index c082a1b..844c441 100644 --- a/infra/doxygen/Doxyfile +++ b/infra/doxygen/Doxyfile @@ -318,7 +318,7 @@ TOC_INCLUDE_HEADINGS = 0 # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. -AUTOLINK_SUPPORT = YES +AUTOLINK_SUPPORT = NO # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this diff --git a/runtime/neurun/api/include/nnfw.h b/runtime/neurun/api/include/nnfw.h index 6e99f0b..1e18dea 100644 --- a/runtime/neurun/api/include/nnfw.h +++ b/runtime/neurun/api/include/nnfw.h @@ -14,6 +14,10 @@ * limitations under the License. */ +/** + * @file nnfw.h + * @brief This file describes runtime API + */ #ifndef __NNFW_H__ #define __NNFW_H__ @@ -25,7 +29,7 @@ extern "C" { #endif /** - * nnfw_session is session to query with runtime + * @brief Session to query with runtime * *

nnfw_session is started and passed by calling {@link nnfw_create_session}. * Each session has its own inference environment, such as model to inference, backend usage, etc. @@ -56,7 +60,7 @@ extern "C" { typedef struct nnfw_session nnfw_session; /** - * Tensor types + * @brief Tensor types * * The type of tensor represented in {@link nnfw_tensorinfo} */ @@ -76,7 +80,7 @@ typedef enum { } NNFW_TYPE; /** - * Result Values + * @brief Result Values */ typedef enum { /** Successful */ @@ -86,7 +90,7 @@ typedef enum { } NNFW_STATUS; /** - * Data format of a tensor + * @brief Data format of a tensor */ typedef enum { /** Don't care layout */ @@ -104,7 +108,7 @@ typedef enum { } NNFW_LAYOUT; /** - * tensor_info describes the type and shape of tensors + * @brief tensor info describes the type and shape of tensors * *

This structure is used to describe input and output tensors. * Application can get input and output tensor type and shape described in model by using @@ -128,7 +132,7 @@ typedef struct nnfw_tensorinfo } nnfw_tensorinfo; /** - * Create a new session instance. + * @brief Create a new session instance. * *

This only creates a session. * Model is loaded after {@link nnfw_load_model_from_file} is invoked. @@ -138,12 +142,12 @@ typedef struct nnfw_tensorinfo * if session is no longer need * * @param[out] session The session to be created - * @return @c NNFW_STATUS_NO_ERROR if successful + * @return NNFW_STATUS_NO_ERROR if successful */ NNFW_STATUS nnfw_create_session(nnfw_session **session); /** - * Close a session instance + * @brief Close a session instance * * After called, access to closed session by application will be invalid * @@ -165,10 +169,10 @@ NNFW_STATUS nnfw_load_model_from_file(nnfw_session *session, const char *package /** * @brief Apply i-th input's tensor info to resize input tensor * - * This function should be called before {@link nnfw_prepare} is invoked, and - * should be called after {@link nnfw_load_model_from_file} is invoked - * See {@link nnfw_prepare} for information applying updated tensor info - * If this function is called many times for same index, tensor info is overwritten + * This function should be called before {@link nnfw_prepare} is invoked, and + * should be called after {@link nnfw_load_model_from_file} is invoked + * See {@link nnfw_prepare} for information applying updated tensor info + * If this function is called many times for same index, tensor info is overwritten * * @param[in] session Session to the input tensor info is to be set * @param[in] index Index of input to be applied (0-indexed) @@ -181,9 +185,9 @@ NNFW_STATUS nnfw_apply_tensorinfo(nnfw_session *session, uint32_t index, /** * @brief Prepare session to be ready for inference * - * This phase may finalize model compilation, scheduling, and additional settings. - * If {@link nnfw_apply_tensor} is called to apply input tensor info different with model - * before this function, tries to resize all tensors. + * This phase may finalize model compilation, scheduling, and additional settings. + * If {@link nnfw_apply_tensor} is called to apply input tensor info different with model + * before this function, tries to resize all tensors. * * @param[in] session the session to be prepared * @return @c NNFW_STATUS_NO_ERROR if successful, otherwise return @c NNFW_STATUS_ERROR @@ -265,8 +269,9 @@ NNFW_STATUS nnfw_input_size(nnfw_session *session, uint32_t *number); NNFW_STATUS nnfw_output_size(nnfw_session *session, uint32_t *number); /** - * Set the layout of an input - * @note The input that does not call this has NNFW_LAYOUT_NHWC layout + * @brief Set the layout of an input + * + * The input that does not call this has NNFW_LAYOUT_NHWC layout * * @param[in] session session from inference input is to be extracted * @param[in] index index of input to be set (0-indexed) @@ -277,8 +282,9 @@ NNFW_STATUS nnfw_output_size(nnfw_session *session, uint32_t *number); NNFW_STATUS nnfw_set_input_layout(nnfw_session *session, uint32_t index, NNFW_LAYOUT layout); /** - * Set the layout of an output - * @note The output that does not call this has NNFW_LAYOUT_NHWC layout + * @brief Set the layout of an output + * + * The output that does not call this has NNFW_LAYOUT_NHWC layout * * @param[in] session session from inference output is to be extracted * @param[in] index index of output to be set (0-indexed) @@ -327,12 +333,14 @@ NNFW_STATUS nnfw_output_tensorinfo(nnfw_session *session, uint32_t index, /** * @brief Set available backends * - * Note: This function should be called before {@link nnfw_prepare} is invoked. - * Possible backend strings are: "cpu", "acl_cl", "acl_neon", "srcn" - * Supported backends differs on each platforms. - * For example, `x86_64` supports "cpu" only. - * Can set multiple backends by semicolon (ex: "acl_cl;cpu"). - * Among the multiple backends, the 1st element is used as default backend. + * This function should be called before {@link nnfw_prepare} is invoked. + * + *

Supported backends differs on each platforms. + * For example, `x86_64` supports "cpu" only. + * Can set multiple backends by semicolon (ex: "acl_cl;cpu"). + * Among the multiple backends, the 1st element is used as default backend.

+ * + * @note Possible backend strings are: "cpu", "acl_cl", "acl_neon", "srcn" * * @param[in] session session to which avilable backends are set * @param[in] backends available backends on which nnfw uses @@ -344,12 +352,14 @@ NNFW_STATUS nnfw_set_available_backends(nnfw_session *session, const char *backe /** * @brief Set the operation's backend * - * Note: This function should be called before {@link nnfw_prepare} is invoked. - * Possible backend strings are: "cpu", "acl_cl", "acl_neon" - * Supported backends differs on each platforms. - * For example, `x86_64` supports "cpu" only. - * The backend for op has higher priority than default backend specified by - * nnfw_set_default_backend. + * This function should be called before {@link nnfw_prepare} is invoked. + * + *

Supported backends differs on each platforms. + * For example, `x86_64` supports "cpu" only. + * The backend for op has higher priority than default backend specified by + * nnfw_set_default_backend.

+ * + * @note Possible backend strings are: "cpu", "acl_cl", "acl_neon" * * @param[in] session session to be modified * @param[in] op operation to be set