1 files changed, 13 insertions, 0 deletions
diff --git a/src/warning.h b/src/warning.h
index 6d25783f4..8c14e2869 100644
--- a/src/warning.h
+++ b/src/warning.h
@@ -10,13 +10,26 @@
 #include "common.h"
 #include "git2/sys/warning.h"
 
+/**
+ * Use this to raise a warning
+ *
+ * @param warning A git_warning_t code from include/git2/sys/warning.h
+ * @param default_rval Default return value (i.e. error code or zero)
+ * @param fmt Printf-style format string for warning message
+ * @return 0 to continue, less than 0 to raise error
+ */
 int git_warn(
 	git_warning_t warning,
+	int default_rval,
 	const char *fmt,
 	...);
 
+/**
+ * Raise a warning about invalid data, via a git_warning_invalid_data struct
+ */
 int git_warn_invalid_data(
 	git_warning_t warning,
+	int default_rval,
 	const char *data,
 	int datalen,
 	const char *fmt,