Skip to content

Commit 09e2ea2

Browse files
committed
deprecation: provide docurium deprecation note
Add `@deprecated` to the functions that are, so that they'll appear that way in docurium.
1 parent 53d13fb commit 09e2ea2

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

include/git2/deprecated.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ GIT_BEGIN_DECL
4040
* This function is deprecated, but there is no plan to remove this
4141
* function at this time.
4242
*
43+
* @deprecated Use git_buf_dispose
4344
* @see git_buf_dispose
4445
*/
4546
GIT_EXTERN(void) git_buf_free(git_buf *buffer);
@@ -100,6 +101,7 @@ GIT_EXTERN(void) git_buf_free(git_buf *buffer);
100101
* This function is deprecated, but there is no plan to remove this
101102
* function at this time.
102103
*
104+
* @deprecated Use git_error_last
103105
* @see git_error_last
104106
*/
105107
GIT_EXTERN(const git_error *) giterr_last(void);
@@ -111,6 +113,7 @@ GIT_EXTERN(const git_error *) giterr_last(void);
111113
* This function is deprecated, but there is no plan to remove this
112114
* function at this time.
113115
*
116+
* @deprecated Use git_error_clear
114117
* @see git_error_clear
115118
*/
116119
GIT_EXTERN(void) giterr_clear(void);
@@ -122,6 +125,7 @@ GIT_EXTERN(void) giterr_clear(void);
122125
* This function is deprecated, but there is no plan to remove this
123126
* function at this time.
124127
*
128+
* @deprecated Use git_error_set_str
125129
* @see git_error_set_str
126130
*/
127131
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);
133137
* This function is deprecated, but there is no plan to remove this
134138
* function at this time.
135139
*
140+
* @deprecated Use git_error_set_oom
136141
* @see git_error_set_oom
137142
*/
138143
GIT_EXTERN(void) giterr_set_oom(void);

0 commit comments

Comments
 (0)