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 618498 - Migrate API docs from templates to source files (GdkWindow)
Migrate API docs from templates to source files (GdkWindow)
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
unspecified
Other All
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks: 599599
 
 
Reported: 2010-05-13 02:54 UTC by Tadej Borovšak
Modified: 2010-05-14 15:21 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Patch that migrates API docs. (69.64 KB, patch)
2010-05-13 02:54 UTC, Tadej Borovšak
needs-work Details | Review
Updated patch (69.68 KB, patch)
2010-05-14 10:26 UTC, Tadej Borovšak
committed Details | Review

Description Tadej Borovšak 2010-05-13 02:54:24 UTC
Created attachment 160946 [details] [review]
Patch that migrates API docs.

Patch that migrates GdkWindow related docs to comments in sources.
Comment 1 Javier Jardón (IRC: jjardon) 2010-05-13 03:21:26 UTC
Review of attachment 160946 [details] [review]:

The patch looks good, only some minor comments

::: gdk/gdktypes.h
@@ +61,3 @@
+ * GDK_PARENT_RELATIVE:
+ *
+ * A special value for <literal>GdkPixmap*</literal> variables, indicating

You can use #GdkPixmap here

::: gdk/gdkwindow.c
@@ +101,3 @@
+ *   cairo_t *cr;
+ *
+ *   // get our child (in this case, the event box)

Do not use C99 comments, use /**/ instead
Comment 2 Tadej Borovšak 2010-05-14 10:26:16 UTC
Created attachment 161034 [details] [review]
Updated patch
Comment 3 Tadej Borovšak 2010-05-14 10:26:56 UTC
Comment on attachment 161034 [details] [review]
Updated patch

Updated patch per recommendations.
Comment 4 Javier Jardón (IRC: jjardon) 2010-05-14 15:21:11 UTC
Comment on attachment 161034 [details] [review]
Updated patch

Committed a bit different patch in commit ff61948d1393c7500ecbea4b03c87c744ce371b7

I've put the doc example code in examples/gdk
Comment 5 Javier Jardón (IRC: jjardon) 2010-05-14 15:21:27 UTC
This problem has been fixed in the development version. The fix will be available in the next major software release.

Thank you for your bug report.