Improve the PJNATH documentation

git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@1914 74dad513-b988-da41-8d7b-12977e46ad98

5 files changed, 17 insertions, 10 deletions

diff --git a/pjnath/include/pjnath/turn_session.h b/pjnath/include/pjnath/turn_session.h
index 0c0f3cef..2c10387b 100644
--- a/pjnath/include/pjnath/turn_session.h
+++ b/pjnath/include/pjnath/turn_session.h
@@ -308,7 +308,7 @@ PJ_DECL(pj_status_t) pj_turn_session_set_server(pj_turn_session *sess,
 /**
  * Set credential to be used by the session.
  */
-PJ_DECL(pj_status_t) pj_turn_session_set_cred(pj_turn_session *sess,
+PJ_DECL(pj_status_t) pj_turn_session_set_credential(pj_turn_session *sess,
 					      const pj_stun_auth_cred *cred);
 
 
diff --git a/pjnath/include/pjnath/types.h b/pjnath/include/pjnath/types.h
index 1d6dc696..88872dcb 100644
--- a/pjnath/include/pjnath/types.h
+++ b/pjnath/include/pjnath/types.h
@@ -140,6 +140,15 @@ PJ_END_DECL
  * messages.
  * 
  *
+ * \n
+ *
+ * \subsection PJNATH_STUN_CLASSES PJNATH Class Diagram
+ *
+ * 
+ * \image html UML-class-diagram.png "Class Diagram"
+ *
+ * TBD: write descriptions.
+ *
  * \subsection PJNATH_STUN_USING Using STUN Library
  *
  * [The developers guide documentation can certainly be improved here]
@@ -155,11 +164,11 @@ PJ_END_DECL
  *
  * References for STUN:
  *
- *  - <A HREF="http://www.ietf.org/internet-drafts/draft-ietf-behave-rfc3489bis-11.txt">
- *    <B>draft-ietf-behave-rfc3489bis-11</b></A>: Session Traversal 
+ *  - <A HREF="http://www.ietf.org/internet-drafts/draft-ietf-behave-rfc3489bis-15.txt">
+ *    <B>draft-ietf-behave-rfc3489bis-15</b></A>: Session Traversal 
  *     Utilities for (NAT) (STUN),
- *  - <A HREF="http://www.ietf.org/internet-drafts/draft-ietf-behave-turn-03.txt">
- *    <B>draft-ietf-behave-turn-03</B></A>: Obtaining Relay Addresses 
+ *  - <A HREF="http://www.ietf.org/internet-drafts/draft-ietf-behave-turn-07.txt">
+ *    <B>draft-ietf-behave-turn-07</B></A>: Obtaining Relay Addresses 
  *    from Simple Traversal Underneath NAT (STUN)
  *  - Obsoleted: <A HREF="http://www.ietf.org/rfc/rfc3489.txt">RFC 3489</A>.
  *
diff --git a/pjnath/src/pjnath/turn_session.c b/pjnath/src/pjnath/turn_session.c
index 354b9661..2c191f47 100644
--- a/pjnath/src/pjnath/turn_session.c
+++ b/pjnath/src/pjnath/turn_session.c
@@ -555,10 +555,11 @@ on_return:
 /**
  * Set credential to be used by the session.
  */
-PJ_DEF(pj_status_t) pj_turn_session_set_cred(pj_turn_session *sess,
+PJ_DEF(pj_status_t) pj_turn_session_set_credential(pj_turn_session *sess,
 					     const pj_stun_auth_cred *cred)
 {
     PJ_ASSERT_RETURN(sess && cred, PJ_EINVAL);
+    PJ_ASSERT_RETURN(sess->stun, PJ_EINVALIDOP);
 
     pj_lock_acquire(sess->lock);
 
diff --git a/pjnath/src/pjnath/turn_sock.c b/pjnath/src/pjnath/turn_sock.c
index 0a3c5465..cd2e08d4 100644
--- a/pjnath/src/pjnath/turn_sock.c
+++ b/pjnath/src/pjnath/turn_sock.c
@@ -335,7 +335,7 @@ PJ_DEF(pj_status_t) pj_turn_sock_init(pj_turn_sock *turn_sock,
 
     /* Set credental */
     if (cred) {
-	status = pj_turn_session_set_cred(turn_sock->sess, cred);
+	status = pj_turn_session_set_credential(turn_sock->sess, cred);
 	if (status != PJ_SUCCESS) {
 	    sess_fail(turn_sock, "Error setting credential", status);
 	    return status;
diff --git a/pjnath/src/pjturn-client/client_main.c b/pjnath/src/pjturn-client/client_main.c
index 0ec61160..19c6cf33 100644
--- a/pjnath/src/pjturn-client/client_main.c
+++ b/pjnath/src/pjturn-client/client_main.c
@@ -419,9 +419,6 @@ static void console_main(void)
 	    if (status != PJ_SUCCESS)
 		my_perror("turn_udp_bind_channel() failed", status);
 	    break;
-	case 'd':
-	    pj_pool_factory_dump(&g.cp.factory, PJ_TRUE);
-	    break;
 	case 'x':
 	    if (g.relay == NULL) {
 		puts("Error: no relay");