diff --git a/docs/Doxyfile b/docs/Doxyfile index bb2984c..104c1e7 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -2052,7 +2052,7 @@ ENABLE_PREPROCESSING = YES # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -MACRO_EXPANSION = NO +MACRO_EXPANSION = YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then # the macro expansion is limited to the macros specified with the PREDEFINED and @@ -2060,7 +2060,7 @@ MACRO_EXPANSION = NO # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -EXPAND_ONLY_PREDEF = NO +EXPAND_ONLY_PREDEF = YES # If the SEARCH_INCLUDES tag is set to YES, the include files in the # INCLUDE_PATH will be searched if a #include is found. @@ -2092,7 +2092,7 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = +PREDEFINED = "MENOH_DEPRECATED_ATTRIBUTE(x)=\deprecated" # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/include/menoh/menoh.h b/include/menoh/menoh.h index e8375c1..953962f 100644 --- a/include/menoh/menoh.h +++ b/include/menoh/menoh.h @@ -200,6 +200,7 @@ void MENOH_API menoh_delete_variable_profile_table_builder( /*! \brief Add input profile * * Input profile contains name, dtype and dims. + * \note Users can free dims buffer after calling this function. */ menoh_error_code MENOH_API menoh_variable_profile_table_builder_add_input_profile( @@ -210,6 +211,7 @@ menoh_variable_profile_table_builder_add_input_profile( * * Input profile contains name, dtype and dims (num, size). This 2D input is * conventional batched 1D inputs. + * \warning This function is depreated. Please use menoh_variable_profile_table_builder_add_input_profile() instead */ MENOH_DEPRECATED_ATTRIBUTE( "please use menoh_variable_profile_table_builder_add_input_profile() instead") @@ -223,6 +225,7 @@ menoh_variable_profile_table_builder_add_input_profile_dims_2( * Input profile contains name, dtype and dims (num, channel, height, width). * This 4D input is conventional batched image inputs. Image input is * 3D(channel, height, width). + * \warning This function is depreated. Please use menoh_variable_profile_table_builder_add_input_profile() instead */ MENOH_DEPRECATED_ATTRIBUTE( "please use menoh_variable_profile_table_builder_add_input_profile() instead") @@ -240,10 +243,11 @@ menoh_variable_profile_table_builder_add_input_profile_dims_4( menoh_error_code MENOH_API menoh_variable_profile_table_builder_add_output_name( menoh_variable_profile_table_builder_handle builder, const char* name); -/*! \brief [DEPRECATED] Add output profile +/*! \brief Add output profile * * Output profile contains name and dtype. Its dims are calculated automatically * when calling of menoh_build_variable_profile_table. + * \warning This function is depreated. Please use menoh_variable_profile_table_builder_add_output_name() instead */ MENOH_DEPRECATED_ATTRIBUTE( "please use menoh_variable_profile_table_builder_add_output_name() instead. "