On Fri, 2006-08-11 at 16:40 +0530, Mayank Jain wrote: > 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?
As far as I know, if its a static function and thus it isn't in
e-text.h, then it won't be output.
Ross
--
Ross Burton mail: [EMAIL PROTECTED]
jabber: [EMAIL PROTECTED]
www: http://www.burtonini.com./
PGP Fingerprint: 1A21 F5B0 D8D0 CFE3 81D4 E25A 2D09 E447 D0B4 33DF
signature.asc
Description: This is a digitally signed message part
_______________________________________________ Evolution-hackers mailing list Evolution-hackers@gnome.org http://mail.gnome.org/mailman/listinfo/evolution-hackers
