Change mentions of NULL in C docs to "" for strings, or 'an empty RefPtr', etc.
Link to original bug (#785899)
There was a thread on the mailing list recently where someone had tried to pass the string "nullptr"
to a gtkmm function, thinking that was what the documentation was telling them to do in order to unset an Image.
Of course, that's not the way to do it: usually, a NULL
C string means an empty std::string
or Glib::ustring
after conversion. But the documentation never accounts for this, so NULL
just becomes nullptr
. You have to either figure out what this really means, or become confused like that user did.
Can the documentation conversion process do this for us and produce more useful docs?
This assumes the new advice wouldn't be wrong for any functions (but the current advice already is, so that wouldn't be a loss anyway)
(I feel like this has probably been discussed already but can't see a bug; sorry if it's a dupe)