From dbe55350ce3cbb594226516e47509480dae33170 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Sat, 23 Oct 2021 14:38:32 -0400
Subject: [PATCH] include: Improve doxygen text on SDL_GetRevisionNumber().
---
include/SDL_version.h | 18 ++++++++++++++----
1 file changed, 14 insertions(+), 4 deletions(-)
diff --git a/include/SDL_version.h b/include/SDL_version.h
index 5fddb48cd1..3746fb2219 100644
--- a/include/SDL_version.h
+++ b/include/SDL_version.h
@@ -153,10 +153,20 @@ extern DECLSPEC const char *SDLCALL SDL_GetRevision(void);
* Obsolete function, do not use.
*
* When SDL was hosted in a Mercurial repository, and was built carefully,
- * this would return the revision number that the build was created from.
- * This number was not reliable for several reasons, but more importantly,
- * SDL is now hosted in a git repository, which does not offer numbers at
- * all, only hashes. This function only ever returns zero now. Don't use it.
+ * this would return the revision number that the build was created from. This
+ * number was not reliable for several reasons, but more importantly, SDL is
+ * now hosted in a git repository, which does not offer numbers at all, only
+ * hashes. This function only ever returns zero now. Don't use it.
+ *
+ * Before SDL 2.0.16, this might have returned an unreliable, but non-zero
+ * number.
+ *
+ * \deprecated Use SDL_GetRevision() instead; if SDL was carefully built, it
+ * will return a git hash.
+ *
+ * \returns zero, always, in modern SDL releases.
+ *
+ * \sa SDL_GetRevision
*/
extern SDL_DEPRECATED DECLSPEC int SDLCALL SDL_GetRevisionNumber(void);