On 8/11/06, Ross Burton <[EMAIL PROTECTED]> wrote: > On Fri, 2006-08-11 at 16:09 +0530, Mayank Jain wrote: > > But using gtk-doc style commenting create a problem? > > When I go ahead & document the non-public functions, their doc will > > also be included in gtk-doc output when its generated. > > > > This will grossly confuse the API user as he'll be trying to use a > > private function. > > I don't believe that private functions will be included in the docs, as > (AFAIK) it uses the headers to determine what to output.
Lets take an example... reset_layout is a function related to EText widget & is private to it and is in file $evo/widgets/text/e-text.c /** * reset_layout: * @text: The text widget on which this function will be called * * Resets layout to its default values, checks for an already existing layout * resets it to default values if it exists else create a new layout from #create_layout call * * Return value: Nothing **/ If i include this as doc for the reset_layout function, will it be included in the gtk-doc output? Thanks, Mayank _______________________________________________ Evolution-hackers mailing list [email protected] http://mail.gnome.org/mailman/listinfo/evolution-hackers
