On Tue, 6 Dec 2011 00:57:41 -0500 Michael Blumenkrantz
<[email protected]> said:

> On Tue, 6 Dec 2011 06:53:48 +0100
> Vincent Torri <[email protected]> wrote:
> 
> > On Tue, Dec 6, 2011 at 6:51 AM, Michael Blumenkrantz <
> > [email protected]> wrote:
> > 
> > > On Tue, 6 Dec 2011 06:48:19 +0100
> > > Vincent Torri <[email protected]> wrote:
> > >
> > > > On Tue, Dec 6, 2011 at 6:39 AM, Michael Blumenkrantz <
> > > > [email protected]> wrote:
> > > >
> > > > > On Tue, 6 Dec 2011 06:37:13 +0100
> > > > > Vincent Torri <[email protected]> wrote:
> > > > >
> > > > > > On Tue, Dec 6, 2011 at 4:32 AM, Enlightenment SVN <
> > > > > > [email protected]> wrote:
> > > > > >
> > > > > > > Log:
> > > > > > >
> > > > > > > +EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const char *ip,
> > > int
> > > > > > > port, const char *username);
> > > > > > > +EAPI void             ecore_con_socks4_lookup_set(Ecore_Con_Socks
> > > > > *ecs,
> > > > > > > Eina_Bool enable);
> > > > > > > +EAPI Eina_Bool        ecore_con_socks4_lookup_get(Ecore_Con_Socks
> > > > > *ecs);
> > > > > > > +EAPI Eina_Bool        ecore_con_socks4_remote_exists(const char
> > > *ip,
> > > > > int
> > > > > > > port, const char *username);
> > > > > > > +EAPI void             ecore_con_socks4_remote_del(const char *ip,
> > > int
> > > > > > > port, const char *username);
> > > > > > > +EAPI void             ecore_con_socks_bind_set(Ecore_Con_Socks
> > > *ecs,
> > > > > > > Eina_Bool is_bind);
> > > > > > > +EAPI Eina_Bool        ecore_con_socks_bind_get(Ecore_Con_Socks
> > > *ecs);
> > > > > > > +EAPI unsigned int     ecore_con_socks_version_get(Ecore_Con_Socks
> > > > > *ecs);
> > > > > > > +EAPI void             ecore_con_socks_remote_del(Ecore_Con_Socks
> > > > > *ecs);
> > > > > > > +EAPI void             ecore_con_socks_apply_once(Ecore_Con_Socks
> > > > > *ecs);
> > > > > > > +EAPI void             ecore_con_socks_apply_always
> > > > > > > (Ecore_Con_Socks
> > > > > *ecs);
> > > > > > >
> > > > > >
> > > > > > if you don't add doc to those function with @since, we will forget
> > > that
> > > > > > they have been added. So add the doc now
> > > > > >
> > > > > > Vincent
> > > > > they already have full docs
> > > > >
> > > >
> > > > 1) the doc is not in the header file
> > > and it won't be
> > >
> > 
> > why ? It has been decided to put doc in header files.
> > 
> > Vincent
> > 
> > 
> > > >  2) ecore_con_socks_version_get() has no doc
> > > because it doesn't do anything currently
> > > >
> > > > Vincent
> > >
> actually you may recall a recent poll where people overwhelmingly voted to
> keep them in the .c files. in related facts, there's still tons of docs in
> the .c files. continuing on with related facts, I'm the maintainer of
> ecore-con and it's much easier for me to keep developing it and maintaining
> it by keeping the docs where I code.

actually the opinion was split pretty much 50/50 - and so i cast my deciding
vote to put them in the headers. for better or worse thats where we put them
now because u can NEVER totally remove them from the headers - since that is
the 1 location that at least SOME docs must be, put them all there.

-- 
------------- Codito, ergo sum - "I code, therefore I am" --------------
The Rasterman (Carsten Haitzler)    [email protected]


------------------------------------------------------------------------------
Cloud Services Checklist: Pricing and Packaging Optimization
This white paper is intended to serve as a reference, checklist and point of 
discussion for anyone considering optimizing the pricing and packaging model 
of a cloud services business. Read Now!
http://www.accelacomm.com/jaw/sfnl/114/51491232/
_______________________________________________
enlightenment-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/enlightenment-devel

Reply via email to