Improve wxPropertyGrid::SetSortFunction() documentation

Information about the returned value was incomplete, list all the
possibilities.

See #25452.

(cherry picked from commit ce7273b3ba)
This commit is contained in:
Miguel Gimenez
2025-05-26 17:54:22 +02:00
committed by Vadim Zeitlin
parent 5db4aebde9
commit e04485ddf0
+3 -2
View File
@@ -430,8 +430,9 @@ enum wxPG_KEYBOARD_ACTIONS
Call wxPropertyGrid::SetSortFunction() to set it.
Sort function should return a value greater than 0 if position of p1 is
after p2. So, for instance, when comparing property names, you can use
Sort function should return a value greater than 0 if position of @a p1 is
after @a p2, negative if position of @a p1 is before @a p2 and 0 if they are
equivalent. So, for instance, when comparing property names, you can use the
following implementation:
@code