Clarified SDL_MostSignificantBitIndex32() documentation

slouken · slouken · commit 99a026cfde70 · 2026-03-22T17:52:54.000-07:00
Fixes #15247 (cherry picked from commit f22e088)
diff --git a/include/SDL3/SDL_bits.h b/include/SDL3/SDL_bits.h
@@ -48,8 +48,7 @@ extern __inline int _SDL_bsr_watcom(Uint32);
 /**
  * Get the index of the most significant (set) bit in a 32-bit number.
  *
- * Result is undefined when called with 0. This operation can also be stated
- * as "count leading zeroes" and "log base 2".
+ * This operation can also be stated as "count leading zeroes" and "log base 2".
  *
  * Note that this is a forced-inline function in a header, and not a public
  * API function available in the SDL library (which is to say, the code is

Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,7 @@ extern __inline int _SDL_bsr_watcom(Uint32);`
`48`	`48`	`/**`
`49`	`49`	`* Get the index of the most significant (set) bit in a 32-bit number.`
`50`	`50`	`*`
`51`		`- * Result is undefined when called with 0. This operation can also be stated`
`52`		`- * as "count leading zeroes" and "log base 2".`
	`51`	`+ * This operation can also be stated as "count leading zeroes" and "log base 2".`
`53`	`52`	`*`
`54`	`53`	`* Note that this is a forced-inline function in a header, and not a public`
`55`	`54`	`* API function available in the SDL library (which is to say, the code is`