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 627758 - A way to ignore a symbol
A way to ignore a symbol
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal enhancement
: 1.18
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on: 646094
Blocks:
 
 
Reported: 2010-08-23 19:39 UTC by David Zeuthen (not reading bugmail)
Modified: 2011-09-08 16:40 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Header file (15.02 KB, text/plain)
2010-08-23 19:39 UTC, David Zeuthen (not reading bugmail)
Details
Source file (188.57 KB, text/plain)
2010-08-23 19:40 UTC, David Zeuthen (not reading bugmail)
Details

Description David Zeuthen (not reading bugmail) 2010-08-23 19:39:24 UTC
I am writing a tool called gdbus-codegen(1) that generates GObject C code based on D-Bus introspection data (this tool will likely end up in GLib 2.27/2.28).

In addition to generating code, I'm also generating gtk-doc comments so the user can run gtk-doc on the whole thing. Ideally I don't want the user to write a .types or -sections.txt file and I'm *almost* there. Please see e.g.

 http://people.freedesktop.org/~david/gdbus-codegen-20100629/FooBarProxy.html

Here, I'd like a way to make gtk-doc ignore the following symbols

 - FooBarProxyPrivate
 - FOO_TYPE_BAR_PROXY
 - foo_bar_proxy_get_type()
 - FooBarStubPrivate
 - FOO_TYPE_BAR_STUB
 - foo_bar_stub_get_type()

but I cannot find a way to easily do this. I am requesting a way to do this, for example

 /** <private>
  * FooBarProxyPrivate:
  *
  * The #FooBarProxyPrivate structure contains only private data.
  */
 typedef struct _FooBarProxyPrivate FooBarProxyPrivate;

would do the trick for me. Thanks.

I will attach C and h files that these docs are generated from.
Comment 1 David Zeuthen (not reading bugmail) 2010-08-23 19:39:56 UTC
Created attachment 168582 [details]
Header file
Comment 2 David Zeuthen (not reading bugmail) 2010-08-23 19:40:23 UTC
Created attachment 168583 [details]
Source file
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2010-08-24 17:57:50 UTC
I was actually considering adding a "section:" tag to the docs. This would allow to totally get rid of the -sections.txt file.

I just need to make up my mind wheter it needs separate "section:" and "subsection:" tags or if a combined notation like "section:.private" would be better.
Comment 4 David Zeuthen (not reading bugmail) 2010-08-24 22:01:28 UTC
Sounds great, thanks!
Comment 5 Stefan Sauer (gstreamer, gtkdoc dev) 2010-10-04 09:17:29 UTC
btw. upcomming gtkdoc-1.16 also understand
#ifndef __GTK_DOC_IGNORE__
//delarations to hide from gtk-doc
#endif
Comment 6 Stefan Sauer (gstreamer, gtkdoc dev) 2011-09-08 16:40:58 UTC
gtkdoc-scan is now smarter when generating the -section.txt:
- XxxXxxxPrivate is placed in 'Standard' subsection
- XXX_TYPE_XXXX and xxx_xxxx_get_type() are already placed there.

Should be fix. Please reopen if not.