diff options
| author | Edward Thomson <ethomson@edwardthomson.com> | 2019-01-23 09:44:40 +0000 |
|---|---|---|
| committer | Edward Thomson <ethomson@edwardthomson.com> | 2019-01-25 09:06:50 +0000 |
| commit | 09e2ea2fe116cd1f7b8ada36d62f9907cc5c0d51 (patch) | |
| tree | 4c3cbfd76a8a6f10fbeec2dc79865d64deb09bdc /include/git2 | |
| parent | 53d13fb3e839a677da0a044bedb0c9d4002d7a4a (diff) | |
| download | libgit2-09e2ea2fe116cd1f7b8ada36d62f9907cc5c0d51.tar.gz | |
deprecation: provide docurium deprecation note
Add `@deprecated` to the functions that are, so that they'll appear that
way in docurium.
Diffstat (limited to 'include/git2')
| -rw-r--r-- | include/git2/deprecated.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/include/git2/deprecated.h b/include/git2/deprecated.h index 144ccc5bf..8f4ec8b0c 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); |