Re: Private structures and gtk-doc

[Damon Chaplin <damon helixcode com>]

Federico Mena Quintero wrote:
> 
> Hello,
> 
> Right now the gdk-pixbuf module has something like this:
> 
>         gdk-pixbuf.h:
> 
>                 typedef struct _GdkPixbuf GdkPixbuf;
>                 typedef struct _GdkPixbufAnimation GdkPixbufAnimation;
>                 typedef struct _GdkPixbufFrame GdkPixbufFrame;
> 
>         gdk-pixbuf-private.h:
> 
>                 struct _GdkPixbuf {
>                         ... bla bla ...
>                 };
> 
>                 struct _GdkPixbufAnimation {
>                         ... bla bla ...
>                 };
> 
>                 struct _GdkPixbufAnimation {
>                         ... bla bla ...
>                 };
> 
> The gdk-pixbuf.h is public and does get installed; the
> gdk-pixbuf-private is just used internally by the library and it is
> not installed.
> 
> The problem is that gtk-doc is picking up the private structures when
> scanning the headers.  I do not want this stuff to show up in the
> final SGML files.
> 
> How can I tell gtk-doc about this?

In the XXX-sections.txt file you place the structs in a private
subsection like this:

<SUBSECTION Private>
gldouble


They won't appear in the output then.

Damon