GNOME Bugzilla – Bug 736622
Better mark GtkAlignment as deprecated
Last modified: 2014-09-17 13:36:35 UTC
See the attached patch. I can also check the other recently deprecated classes and do the same if something is missing.
Created attachment 286133 [details] [review] Better mark GtkAlignment as deprecated - Move the class to the Deprecated section. - Warning at the top of the class description. - A missing property was not marked as deprecated. - Update doc of gtk_container_set_border_width() to not mention GtkAlignment.
Review of attachment 286133 [details] [review]: ::: gtk/deprecated/gtkalignment.c @@ +28,3 @@ * @Title: GtkAlignment * + * <warning> This doesn't work, strange, it works fine in GtkSourceView. I've tried with <warning><para>, but it doesn't work either. How to display a warning? It's maybe a bug in GTK-Doc.
Review of attachment 286133 [details] [review]: ::: gtk/deprecated/gtkalignment.c @@ +29,3 @@ * + * <warning> + * GtkAlignment is deprecated and should not be used in newly-written code. we don't use DocBook XML tags in the GLib/GTK documentation any more. in theory, the "Deprecated: <version>: additional text" tag should work on descriptions as well. alternatively, just add the `Deprecated:` tag on the instance structure annotation.
"Deprecated:" in the class description doesn't work, the text is not displayed at all. Putting the warning in the instance struct would make it less visible. The idea was to have the warning as visible as possible, so developers don't loose time by reading the class description, and then figure out that the class is deprecated… Maybe just write "Warning:" in bold at the beginning of the class description?
I'm in favor of keeping things low-key for deprecations, a sentence at the end of the long description is sufficient. Like we do here: https://developer.gnome.org/gtk3/3.13/GtkStatusIcon.html
Created attachment 286370 [details] [review] Better mark GtkAlignment as deprecated - Move the class to the Deprecated section. - Warning at the bottom of the class description. - A missing property was not marked as deprecated. - Update doc of gtk_container_set_border_width() to not mention GtkAlignment.
All other classes deprecated in 3.14 are correctly marked as deprecated in the class description, and are present in the Deprecated section.
Review of attachment 286370 [details] [review]: This looks good to me, thanks
Comment on attachment 286370 [details] [review] Better mark GtkAlignment as deprecated Thanks for the quick review.