On Friday 02 of April 2010 16:31:10 Daniel Stenberg wrote:
> On Fri, 2 Apr 2010, Kamil Dudka wrote:
> > So that CURLE_OK in combination with (*written == 0) means EWOULDBLOCK,
> > am I right?
>
> You're right. A subject for improved internal docs or perhaps an improved
> function/API internally...

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.

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?

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 */

Kamil
-------------------------------------------------------------------
List admin: http://cool.haxx.se/list/listinfo/curl-library
Etiquette: http://curl.haxx.se/mail/etiquette.html
Received on 2010-04-02