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 557779 - In documentation GdkAtom is declared as a structure instead of a pointer
In documentation GdkAtom is declared as a structure instead of a pointer
Status: RESOLVED OBSOLETE
Product: gtk+
Classification: Platform
Component: Documentation
3.22.x
Other All
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks:
 
 
Reported: 2008-10-24 15:28 UTC by Yann Droneaud
Modified: 2018-05-02 14:35 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Yann Droneaud 2008-10-24 15:28:54 UTC 
In http://library.gnome.org/devel/gdk/unstable/gdk-Properties-and-Atoms.html#GdkAtom
 typedef struct _GdkAtom GdkAtom;

In gdk/gdktypes.h
 typedef struct _GdkAtom *GdkAtom;

In the documentation, GdkAtom is not a pointer but a structure.

It's harmless, but after reading the documentation I was wondering how I can safely compare 2 GdkAtom. 

So I search all around the Gdk/Gtk source what was the content of the struct _GdkAtom to be sure the struct was mapped to a simple scalar like an XID.

I ask the question on IRC (#gtk+ on irc.gnome.org) and hopefuly "ebassi" show me the little star which is so helpful.


To sum up, the documentation should not miss the pointer type declaration, specify that GdkAtom are unique, and can be compared with == .
Comment 1 Yann Droneaud 2009-03-23 11:22:56 UTC 
Fixed bug title s/GtkAdom/GtkAtom.

Btw, this issue is still valid.
Comment 2 Daniel Boles 2017-10-30 09:49:38 UTC 
same cause as Bug 779501, an (errant?) override in the docs:

https://git.gnome.org/browse/gtk+/tree/docs/reference/gdk/gdk3-overrides.txt?h=gtk-3-22#n2
Comment 3 GNOME Infrastructure Team 2018-05-02 14:35:26 UTC 
-- GitLab Migration Automatic Message --

This bug has been migrated to GNOME's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/gtk/issues/302.