On Fri, 2 Apr 2010, Kamil Dudka wrote:

> Thanks for looking into this! I am about to write the patch and now got a
> bit confused. What's the proper place for function's documentation in the
> cURL coding style? It seems fairly inconsistent to me.

Right, we've never been very picky on how or where the docs for the internal
functions is made. Inconsistency is far better than total absense!

> Should the documentation of a function be in .h or in .c when the function
> has an external declaration? Or both places? If so, should the
> documentation be identical?

I think I've tried to put them in both places, but I could also be happy with
only having them in the .h file.

> Going through the SSL backends, I see the _send and _recv functions has also
> some fragments of documentation. What if we replace them by a link to the
> documentation in sslgen.h or sslgen.c to keep it at one place?
>
> /* for documentation see Curl_ssl_send() in sslgen.h */

Sure, that'd be great!

-- 
  / daniel.haxx.se
-------------------------------------------------------------------
List admin: http://cool.haxx.se/list/listinfo/curl-library
Etiquette:  http://curl.haxx.se/mail/etiquette.html