GNOME Bugzilla – Bug 627758
A way to ignore a symbol
Last modified: 2011-09-08 16:40:58 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.
Created attachment 168582 [details] Header file
Created attachment 168583 [details] Source file
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.
Sounds great, thanks!
btw. upcomming gtkdoc-1.16 also understand #ifndef __GTK_DOC_IGNORE__ //delarations to hide from gtk-doc #endif
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.