Re: [PATCH 2/2] Add document about exported enum definitions

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sat, Apr 27, 2013 at 12:29:46AM -0300, Lucas De Marchi wrote:
> On Sat, Apr 27, 2013 at 12:24 AM, Lucas De Marchi
> >
> > It's not acceptable in the public header and throughout the source
> > code. Since this is a limitation of gtk-doc and that in C you can add
> > the typedef anywhere, what could be done is to document these enums
> > hidden in the end of the respective .c file. And throughout the source
> > code we continue to use "enum ...". So you wouldn't touch the header,
> > but would have this, for example in the ende of
> > libkmod/libkmod-module.c:
> >
> >
> > /** kmod_module_probe_flags:
> >  * @KMOD_PROBE_FORCE_VERMAGIC: remove version magic to force insert module
> >  * @KMOD_PROBE_FORCE_MODVERSION: remove interface version to force insert module
> >  * ...
> >  */
> > typedef enum kmod_module_probe_flags kmod_module_probe_flags;
> 
> 
> oh... and don't rename the enums, otherwise we break the API. This one
> should be "enum kmod_probe", not kmod_module_probe_flags.

Sure, that's fine.

--
Thanks,
Chengwei

> 
> 
> Lucas De Marchi

Attachment: signature.asc
Description: Digital signature


[Index of Archives]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [Big List of Linux Books]

  Powered by Linux