From e04485ddf0484923eb94479cb2b1cdb7261daa35 Mon Sep 17 00:00:00 2001 From: Miguel Gimenez Date: Mon, 26 May 2025 16:19:01 +0200 Subject: [PATCH] Improve wxPropertyGrid::SetSortFunction() documentation Information about the returned value was incomplete, list all the possibilities. See #25452. (cherry picked from commit ce7273b3ba3905dbf2b7621e7a55ae0b9b5c7d0f) --- interface/wx/propgrid/propgrid.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/interface/wx/propgrid/propgrid.h b/interface/wx/propgrid/propgrid.h index b267faa6c2..9af854d510 100644 --- a/interface/wx/propgrid/propgrid.h +++ b/interface/wx/propgrid/propgrid.h @@ -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