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
>
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.
> >
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
On 8/11/06, Mayank Jain <[EMAIL PROTECTED]> wrote:
> On 8/10/06, Andre Klapper <[EMAIL PROTECTED]> wrote:
> > hej mayank,
> >
> > Am Mittwoch, den 09.08.2006, 17:43 +0530 schrieb Mayank Jain:
> > > With that in mind, I would like to add more documentation, comments
> > > (with whatever knowledge I
On 8/10/06, Andre Klapper <[EMAIL PROTECTED]> wrote:
> hej mayank,
>
> Am Mittwoch, den 09.08.2006, 17:43 +0530 schrieb Mayank Jain:
> > With that in mind, I would like to add more documentation, comments
> > (with whatever knowledge I have) to the code.
>
> any additional documentation is most app
hej mayank,
Am Mittwoch, den 09.08.2006, 17:43 +0530 schrieb Mayank Jain:
> With that in mind, I would like to add more documentation, comments
> (with whatever knowledge I have) to the code.
any additional documentation is most appreciated!
matthew already posted about gtk-doc which would be imo
hej mayank,
Am Mittwoch, den 09.08.2006, 17:43 +0530 schrieb Mayank Jain:
> With that in mind, I would like to add more documentation, comments
> (with whatever knowledge I have) to the code.
as you already noted, being a newbie and trying to code on evolution is
very hard, therefore any addition
On 8/9/06, Matthew Barnes <[EMAIL PROTECTED]> wrote:
> On Wed, 2006-08-09 at 17:43 +0530, Mayank Jain wrote:
> Probably want to stick to a format that GTK-Doc [1] can parse.
>
> For example:
>
> /**
> * function_name:
> * @arg1: description of arg1
> * @arg2: description of arg2
> *
> * Descri
On Wed, 2006-08-09 at 17:43 +0530, Mayank Jain wrote:
> This documentation can be like a header to functions like...
>
> /
> Use - describe the function in 2-3 lines
> Input - input args
> Output - return values
> /
Probably want to stick to a format that GTK-Doc [1] can parse.
For examp
Hi all,
When I started working on Evolution, all I had was
http://www.go-evolution.org/index.php/Evolution_Architecture as a
reference document & lots & lots of code to read. It would have been
easier if the code was more documented.
With that in mind, I would like to add more documentation, comm
10 matches
Mail list logo
