GNOME Bugzilla – Bug 678566
Missing information in documentation string
Last modified: 2012-06-27 15:49:40 UTC
Hello all, There is a typo or some kind of information missing in a string in gtkmm documentation. The string ID is 1021, and it reads: "[...]Class scope widgets also require Automatic widgets in class scope suffer the same disadvantages as any other class scope automatic variable." That does not make any sense, I guess it should read "[...]also require something...[...]" Thanks in advance. -- Nicolás Satragno <nsatragno@gmail.com>
Yes. I don't know what that's meant to say.
Here you can see the string with context: #: C/gtkmm-tutorial-in.xml:6117(para) #, fuzzy msgid "" "The primary disadvantages of using class scope widgets are revealing the class implementation rather than the class interface in the class header. Class scope widgets also require Automatic widgets in class scope suffer the same disadvantages as any other class scope automatic variable."
I thought that perhaps this paragraph had been undeliberately distorted during some update, but the wording has been the same since time immemorial. Or at least since gtkmm/docs/tutorial/gtkmm-tut.xml and the rest of gtkmm was first added to the git repository in January 2003. (That file was later moved to gtkmm-documentation/docs/tutorial/C/gtkmm-tutorial-in.xml.)
Perhaps no information is missing, but on the contrary, a few extra words have been copied into the text by mistake. This would make some sense: "The primary disadvantages of using class scope widgets are revealing the class implementation rather than the class interface in the class header. Class scope widgets also suffer the same disadvantages as any other class scope automatic variable." But I don't understand what those disadvantages with other class scope variables are. Let's just delete the last sentence, and keep only: "The primary disadvantage of using class scope widgets is revealing the class implementation rather than the class interface in the class header." I'll fix that, unless someone objects fairly quickly. I'll also fix some of the code snippets in the "Widgets" section of the "Memory management" chapter. They need some update. Gtk::Object::set_manage() shall not be mentioned at all. In gtkmm/gtk/gtkmm/object.h it's declared within #ifndef DOXYGEN_SHOULD_SKIP_THIS, and commented "Used by Gtk::manage(). You should not need to use this directly."
Pushed a patch that fixes this bug. http://git.gnome.org/browse/gtkmm-documentation/commit/?id=844041fdb3b46e95244d73487732d2de686fa6ab
Kjell, many thanks for fixing it :) Cheers