summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcollin <collin+i@collinmcqueen.com>2021-04-22 15:21:49 -0400
committercollin <collin+i@collinmcqueen.com>2021-04-22 15:21:49 -0400
commitbede6f04de8653c81c5d53af7de34feff04b5d12 (patch)
treee5cd61d58cca64d29953b19a83785d8501aefa22
parenta03c69403fe14790e6b6738a65820c1ae69e95c5 (diff)
downloadsdl_core-bede6f04de8653c81c5d53af7de34feff04b5d12.tar.gz
deprecate ini_file
-rw-r--r--src/components/config_profile/include/config_profile/ini_file.h14
1 files changed, 13 insertions, 1 deletions
diff --git a/src/components/config_profile/include/config_profile/ini_file.h b/src/components/config_profile/include/config_profile/ini_file.h
index 204fb6c7bf..cfb2f74c6d 100644
--- a/src/components/config_profile/include/config_profile/ini_file.h
+++ b/src/components/config_profile/include/config_profile/ini_file.h
@@ -87,13 +87,19 @@ extern "C" {
/*
* @brief Write usage instructions to the end of the file
* @param
- *
+ *
+ * \deprecated This method will be removed in the next major release
+ * See Profile::UpdateValues for the new ini parsing code
+ *
* @return NULL if file or desired entry not found, otherwise pointer to fname
*/
extern char* ini_write_inst(const char* fname, uint8_t flag);
/*
* @brief Read a certain item of the specified chapter of a ini-file
+ *
+ * \deprecated This method will be removed in the next major release
+ * See Profile::UpdateValues for the new ini parsing code
*
* @return NULL if file or desired entry not found, otherwise pointer to value
*/
@@ -104,6 +110,9 @@ extern char* ini_read_value(const char* fname,
/*
* @brief Write a certain item of the specified chapter of a ini-file
+ *
+ * \deprecated This method will be removed in the next major release
+ * See Profile::UpdateValues for the new ini parsing code
*
* @return NULL if file not found, otherwise pointer to value
*/
@@ -116,6 +125,9 @@ extern char ini_write_value(const char* fname,
/*
* @brief Parse the given line for the item and returns the value if
* there is one otherwise NULL
+ *
+ * \deprecated This method will be removed in the next major release
+ * See Profile::UpdateValues for the new ini parsing code
*
* @return NULL if desired entry not found, otherwise pointer to value
*/