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

[Simon Perreault]

Olle E. Johansson wrote, on 07/28/2010 04:37 PM:
> 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.

Of course I'm combining the two. The .c file is documented in the .h file. I
fail to see how this can be a problem. If you wish, move all the Doxygen
comments from the .h file to the .c file. I don't care.

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

(Feel free to take this and put it in the Doxygen comments if you think it is
worthwhile.)

We still have netsock because there are still channels that use it. Once all
channels are converted to netsock2, netsock will be removed. netsock has no
advantage over netsock2.

The difference between the two is simple: netsock is IPv4-only while netsock2 is
version-independent.

> 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.

If you mean we need complete examples, I agree.

The rest of that page seems to be per-function documentation, which we already have.

Simon
-- 
NAT64/DNS64 open-source --> http://ecdysis.viagenie.ca
STUN/TURN server        --> http://numb.viagenie.ca
vCard 4.0               --> http://www.vcarddav.org