Commit 09e2ea2fe116cd1f7b8ada36d62f9907cc5c0d51
2019-01-23T09:44:40
deprecation: provide docurium deprecation note Add `@deprecated` to the functions that are, so that they'll appear that way in docurium.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
diff --git a/include/git2/deprecated.h b/include/git2/deprecated.h
index 144ccc5..8f4ec8b 100644
--- a/include/git2/deprecated.h
+++ b/include/git2/deprecated.h
@@ -40,6 +40,7 @@ GIT_BEGIN_DECL
* This function is deprecated, but there is no plan to remove this
* function at this time.
*
+ * @deprecated Use git_buf_dispose
* @see git_buf_dispose
*/
GIT_EXTERN(void) git_buf_free(git_buf *buffer);
@@ -100,6 +101,7 @@ GIT_EXTERN(void) git_buf_free(git_buf *buffer);
* This function is deprecated, but there is no plan to remove this
* function at this time.
*
+ * @deprecated Use git_error_last
* @see git_error_last
*/
GIT_EXTERN(const git_error *) giterr_last(void);
@@ -111,6 +113,7 @@ GIT_EXTERN(const git_error *) giterr_last(void);
* This function is deprecated, but there is no plan to remove this
* function at this time.
*
+ * @deprecated Use git_error_clear
* @see git_error_clear
*/
GIT_EXTERN(void) giterr_clear(void);
@@ -122,6 +125,7 @@ GIT_EXTERN(void) giterr_clear(void);
* This function is deprecated, but there is no plan to remove this
* function at this time.
*
+ * @deprecated Use git_error_set_str
* @see git_error_set_str
*/
GIT_EXTERN(void) giterr_set_str(int error_class, const char *string);
@@ -133,6 +137,7 @@ GIT_EXTERN(void) giterr_set_str(int error_class, const char *string);
* This function is deprecated, but there is no plan to remove this
* function at this time.
*
+ * @deprecated Use git_error_set_oom
* @see git_error_set_oom
*/
GIT_EXTERN(void) giterr_set_oom(void);