Cosmetics, documentation.

src/audio/audiortp.h

@@ -31,7 +31,8 @@
 #include <samplerate.h>
 
 #include "../global.h"
-/** maximum of byte inside an incoming packet 
+
+/** maximum bytes inside an incoming packet 
  *  8000 sampling/s * 20s/1000 = 160
  */
 #define RTP_20S_8KHZ_MAX 160

src/call.h

@@ -33,9 +33,26 @@ typedef std::string CallID;
  */
 class Call{
 public:
-    enum CallType {Incoming, Outgoing};
-    enum ConnectionState {Disconnected, Trying, Progressing, Ringing, Connected };
-    enum CallState {Inactive, Active, Hold, Busy, Refused, Error};
+  /**
+   * This determines if the call originated from the local user (Outgoing)
+   * or from some remote peer (Incoming).
+   */
+  enum CallType {Incoming, Outgoing};
+  
+  /**
+   * Tell where we're at with the call. The call gets Connected when we know
+   * from the other end what happened with out call. A call can be 'Connected'
+   * even if the call state is Busy, Refused, or Error.
+   *
+   * Audio should be transmitted when ConnectionState = Connected AND
+   * CallState = Active.
+   */
+  enum ConnectionState {Disconnected, Trying, Progressing, Ringing, Connected};
+
+  /**
+   * The Call State.
+   */
+  enum CallState {Inactive, Active, Hold, Busy, Refused, Error};
 
     /**
      * Constructor of a call

src/sipvoiplink.cpp

@@ -1436,7 +1436,7 @@ SIPVoIPLink::findSIPCallWithCid(int cid)
 {
   if (cid < 1) {
     _debug("! SIP Error: Not enough information for this event\n");
-    return 0;
+    return NULL;
   }
   ost::MutexLock m(_callMapMutex);
   SIPCall* call = 0;
@@ -1448,7 +1448,7 @@ SIPVoIPLink::findSIPCallWithCid(int cid)
     }
     iter++;
   }
-  return 0;
+  return NULL;
 }
 
 SIPCall* 
@@ -1456,7 +1456,7 @@ SIPVoIPLink::findSIPCallWithCidDid(int cid, int did)
 {
   if (cid < 1 && did < -1) {
     _debug("! SIP Error: Not enough information for this event\n");
-    return 0;
+    return NULL;
   }
   ost::MutexLock m(_callMapMutex);
   SIPCall* call = 0;
@@ -1468,7 +1468,7 @@ SIPVoIPLink::findSIPCallWithCidDid(int cid, int did)
     }
     iter++;
   }
-  return 0;
+  return NULL;
 }
 
 SIPCall*
@@ -1478,7 +1478,7 @@ SIPVoIPLink::getSIPCall(const CallID& id)
   if (call) {
     return dynamic_cast<SIPCall*>(call);
   }
-  return 0;
+  return NULL;
 }
 
 /**