After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 611707 - Move documentation from templates to inline comments (GtkPlug, GtkSocket)
Move documentation from templates to inline comments (GtkPlug, GtkSocket)
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
2.19.x
Other All
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks: 599599
 
 
Reported: 2010-03-03 15:17 UTC by Patrick Bernaud
Modified: 2010-04-18 00:50 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Move GtkPlug documentation to inline comments (3.29 KB, patch)
2010-03-03 15:21 UTC, Patrick Bernaud
committed Details | Review
Move GtkSocket documentation to inline comments (8.61 KB, patch)
2010-03-03 15:22 UTC, Patrick Bernaud
needs-work Details | Review
Move GtkSocket documentation to inline comments (8.27 KB, patch)
2010-03-05 22:05 UTC, Patrick Bernaud
committed Details | Review

Description Patrick Bernaud 2010-03-03 15:17:27 UTC
As specified at http://live.gnome.org/GTK%2B/TaskAPIDocMigration
Comment 1 Patrick Bernaud 2010-03-03 15:21:31 UTC
Created attachment 155139 [details] [review]
Move GtkPlug documentation to inline comments
Comment 2 Patrick Bernaud 2010-03-03 15:22:32 UTC
Created attachment 155140 [details] [review]
Move GtkSocket documentation to inline comments
Comment 3 Javier Jardón (IRC: jjardon) 2010-03-05 04:51:29 UTC
Review of attachment 155140 [details] [review]:

Thank you for your patch.

Could you fix the issues commented below?

Also, I'd suggest you to use the git format to send the patches: take a look here for a little guide: http://live.gnome.org/GnomeLove/SubmittingPatches

::: gtk/gtksocket.c
@@ +55,3 @@
+ * @Short_description: Container for widgets from other processes
+ * SECTION:gtksocket
+/**

Don't use a <varlistentry> in @See_also:, replace with a simple list (see gtk/gtkfilechooser.c for example)

@@ +96,3 @@
+ * has been created by examining the
+ * <structfield>plug_window</structfield> field of the
+ * #GtkSocket structure. If this field is non-%NULL,

You should  rephrase this to use gtk_socket_get_plug_window() instead access the structure field directly.
Something like "You can check if the plug has been created by using gtk_socket_get_plug_window()"

::: gtk/gtksocket.h
@@ +52,3 @@
+ *
+ * GtkSocket:
+/**

Now in GTK+ all object structures are opaque, so there is no need to documenting them
Comment 4 Javier Jardón (IRC: jjardon) 2010-03-05 04:52:40 UTC
Comment on attachment 155139 [details] [review]
Move GtkPlug documentation to inline comments

commit 7ab2155aef8e2069a9e5680ca2cd68f70eec43fd
Comment 5 Patrick Bernaud 2010-03-05 22:05:46 UTC
Created attachment 155368 [details] [review]
Move GtkSocket documentation to inline comments
Comment 6 Patrick Bernaud 2010-03-17 17:26:52 UTC
Ping ?
Comment 7 Javier Jardón (IRC: jjardon) 2010-03-17 17:49:10 UTC
Sorry for the delay Patrick, the patch looks good, but the 2.24 release is inminent so no big changes in the code are allowed.

I'll try to apply your patch as soon as 2.20 is released. Thank you!
Comment 8 Javier Jardón (IRC: jjardon) 2010-04-18 00:49:53 UTC
Comment on attachment 155368 [details] [review]
Move GtkSocket documentation to inline comments

commit 6a9b72525ac5324897693d564dd283e50b58c222
Comment 9 Javier Jardón (IRC: jjardon) 2010-04-18 00:50:30 UTC
This problem has been fixed in the development version. The fix will be available in the next major software release.

Thanks Patrick!