TTreeNodeCompare documentation

[Eclipticon]

Hi,

from http://lazarus-ccr.sourceforge.net/docs/lcl/comctrls/ttreenodecompare.html:

"returns -1 if Node1 less than Node2, zero if equal, +1 if Node 2 greater"

Is it just me or is that nonsense? Where to report this and what are the real return values?

[JuhaManninen]

Looks correct to me. The function must return an integer, -1, 0 or 1 just like many other similar comparison functions.
Now only the parameters are TTreeNodes instead of pointers as they often are.

Such comparison functions are typically used by binary search and sort functions.

Juha

[Eclipticon]

Hi Juha,

no, the way this function works it not what worries me, I'm familiar with that.

What confuses me, is that the conditions for -1 and +1 described in that piece of doumentation are the same:

(Node1 < Node2) -> -1
(Node1 < Node2) -> +1

[JuhaManninen]

no, the way this function works it not what worries me, I'm familiar with that.

What confuses me, is that the conditions for -1 and +1 described in that piece of doumentation are the same:

(Node1 < Node2) -> -1
(Node1 < Node2) -> +1

Yes. Good catch.
I fixed the explanation in the XML document file in r34572. I don't know when it will be updated to the HTML page.
Now it says: "... +1 if Node1 is greater"

Juha