GNOME Bugzilla – Bug 506885
Stock ID stuff needs documentation
Last modified: 2009-04-28 07:31:00 UTC
The stock ID stuff is not really documented much at all, and it's not entirely clear how it's supposed to be used or how it all works. It could really use some improved documentation
I guess so. See also http://bugzilla.gnome.org/show_bug.cgi?id=359065
Is there any C documentation that we can be inspired by?
Links to our pages that lack documentation: http://www.gtkmm.org/docs/gtkmm-2.4/docs/reference/html/classGtk_1_1StockID.html http://www.gtkmm.org/docs/gtkmm-2.4/docs/reference/html/structGtk_1_1BuiltinStockID.html http://www.gtkmm.org/docs/gtkmm-2.4/docs/reference/html/namespaceGtk_1_1Stock.html GTK+ has a little more that we should use: http://library.gnome.org/devel/gtk/2.12/gtk-Stock-Items.html
Created attachment 133095 [details] [review] Patch to add more documentation for StockID stuff This patch adds as much documentation as I could find in the gtk+ docs.
+ +/** See IconSet::lookup_default() There is no such method. You are also missing ending "."s in several places. Not only is that correct grammar, but it is required by Doxygen.
Created attachment 133400 [details] [review] Update patch to add the missing "."s This patch fixes the "."s and some minor typos. BTW, IconSet::lookup_default exists: http://www.gtkmm.org/docs/gtkmm-2.4/docs/reference/html/classGtk_1_1IconSet.html#a6cc0560e7f2ced992863f74704570ab
> This patch fixes the "."s and some minor typos. No, it doesn't: + /** Looks for an icon in the list of default icon factories Please correct and commit/push to master. Thanks.