Documentation of the day:

Documentation of the day:

http://docwiki.embarcadero.com/Libraries/XE8/en/System.Classes.GetUltimateOwner

"Left undocumented because it doesn't really do the right thing."

Comments

  1. But straight enough
    Looks like a useful doc for me. Indicating to not use this function

    ReplyDelete
  2. Alexey Petushkov If you clicked the link you noticed that actually it IS documented stating that it does a certain thing. So what? Does it do that or not? So the comment is saying this function should do what the next line says but actually it doesn't? I don't get it.

    ReplyDelete
  3. I dont use anything, if i'm not sure. If doc says to not trust that function, it can have some reasons, like a "shitcoding" or wrong architecture. 
    It is just my opinion on strange documented code. Ussually it is better to not touch it at all.

    ReplyDelete
  4. Nothing new. it's like the product :D

    ReplyDelete
  5. Not documentation of the day, but documentation of the month :)

    ReplyDelete
  6. To me, the docs are the only WTF. If it doesn't work why does it still exists? Shouldn't it be fixed or removed?

    But wait, there is more - Maybe it can't be removed because:
    a) backwards compatibility?
    b) it is used in ToolsApi\TreeIntf !!

    But if it is used in designide.bpl (in the IDE), surely it should be working correctly... - yeah, bold assumption. Does that mean the docs are wrong?

    ReplyDelete
  7. Looks like the documentation has been updated...

    ReplyDelete
  8. But did you see the notes on the changes and the Jira? item it related to - RS-62633

    ReplyDelete

Post a Comment