Re: [Evolution-hackers] Adding documentation to Evolution's code



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.

Ross
-- 
Ross Burton                                 mail: ross burtonini com
                                          jabber: ross burtonini com
                                     www: http://www.burtonini.com./
 PGP Fingerprint: 1A21 F5B0 D8D0 CFE3 81D4 E25A 2D09 E447 D0B4 33DF

Attachment: signature.asc
Description: This is a digitally signed message part



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