[asterisk-dev] main/netsock2.c and documentation

Olle E. Johansson oej at edvina.net
Wed Jul 28 09:37:29 CDT 2010


28 jul 2010 kl. 16.24 skrev Simon Perreault:

> Olle E. Johansson wrote, on 07/28/2010 03:45 PM:
>> main/netsock2.c
>> [...]
>> The number of comments in this file is below par. And we need documentation on what the difference is between netsock and netsock2, why we should use it. There is some brief doxygen in netsock2.h, but it could be much more instructive and verbose.
> 
> Out of 1046 lines total for netsock2.c and netsock2.h, 481 are code. The rest is
> comments and blank lines.
Now you are adding the .c and .h files to get cool stats... The .c file is still very undocumented in the code, which is what I pointed out.

> 
> Please highlight specific things you find in need of documentation, so that we
> may document them.
> 
>> I would really like to be able to understand this code.
> 
> The best way would be to ask specific questions, which we will gladly answer.

What is the difference between netsock2 and netsock? Why do we have two of them?

We need a page like this:
http://www.asterisk.org/doxygen/trunk/AstObj2_Containers.html

that explains this API, like we're trying to make for all APIs.

/O


More information about the asterisk-dev mailing list