[Cogl] [PATCH 1/2] context: glib-mkenums chokes on /*< private >*/ but supports /*< skip >*/

Robert Bragg robert at sixbynine.org
Mon Oct 8 06:46:50 PDT 2012


On Mon, Oct 8, 2012 at 12:13 PM, Lespiau, Damien
<damien.lespiau at intel.com> wrote:
> On Sat, Oct 6, 2012 at 8:13 PM, Robert Bragg <robert at sixbynine.org> wrote:
>> On Sat, Oct 6, 2012 at 1:30 AM, Damien Lespiau <damien.lespiau at gmail.com> wrote:
>>> From: Damien Lespiau <damien.lespiau at intel.com>
>>>
>>> The private option is really part of gtk-doc, glib-mkenums does not
>>> support it. Use skip instead.
>>
>> Don't we want both options in this case so that gtk-doc doesn't show
>> the private enum either, or does gtk-doc also understand skip?
>
> I don't think so, I believe gtk-doc will only look at the @foo in the
> comments, whereas /*< private *>/ in the enum makes glib-mkenums issue
> an error.

I'm fairly sure we are relying on the /*< private >*/ markers since I
recall sitting down with Neil to write a patch at one point for
gtk-doc to fix a bug with how it stripped private values. In the end
we didn't need to keep the patch since it was fixed upstream, but
still that makes me think it can't be enough to rely on just the @foo
comments to delimit public enums otherwise we wouldn't have had to
write that patch.

kind regards,
- Robert
>
> --
> Damien


More information about the Cogl mailing list