aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/arm/arm.h11
-rw-r--r--src/conversation/conversation_api.c6
-rw-r--r--src/conversation/conversation_api_call.c14
-rw-r--r--src/include/gnunet_conversation_service.h17
4 files changed, 21 insertions, 27 deletions
diff --git a/src/arm/arm.h b/src/arm/arm.h
index bf2f7e797..e5a2f9b5e 100644
--- a/src/arm/arm.h
+++ b/src/arm/arm.h
@@ -60,11 +60,12 @@ struct GNUNET_ARM_Message
60 * Reply to client, type is #GNUNET_MESSAGE_TYPE_ARM_RESULT or 60 * Reply to client, type is #GNUNET_MESSAGE_TYPE_ARM_RESULT or
61 * #GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT. 61 * #GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT.
62 * OR 62 * OR
63 * Request from client, type is #GNUNET_MESSAGE_TYPE_ARM_REQUEST 63 * Request from client, type is #GNUNET_MESSAGE_TYPE_ARM_START or
64 * #GNUNET_MESSAGE_TYPE_ARM_STOP.
64 */ 65 */
65 struct GNUNET_MessageHeader header; 66 struct GNUNET_MessageHeader header;
66 67
67 /** 68 /**
68 * For alignment. 69 * For alignment.
69 */ 70 */
70 uint32_t reserved; 71 uint32_t reserved;
@@ -87,12 +88,12 @@ struct GNUNET_ARM_ResultMessage
87{ 88{
88 89
89 /** 90 /**
90 * Reply to client, of type is GNUNET_MESSAGE_TYPE_ARM_RESULT, with an ID. 91 * Reply to client, of type is #GNUNET_MESSAGE_TYPE_ARM_RESULT, with an ID.
91 */ 92 */
92 struct GNUNET_ARM_Message arm_msg; 93 struct GNUNET_ARM_Message arm_msg;
93 94
94 /** 95 /**
95 * Result from the 'enum GNUNET_ARM_Result' 96 * Result from the `enum GNUNET_ARM_Result`
96 */ 97 */
97 uint32_t result; 98 uint32_t result;
98}; 99};
@@ -106,7 +107,7 @@ struct GNUNET_ARM_ResultMessage
106struct GNUNET_ARM_ListResultMessage 107struct GNUNET_ARM_ListResultMessage
107{ 108{
108 /** 109 /**
109 * Reply to client, of type is GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT, 110 * Reply to client, of type is #GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT,
110 * with an ID. 111 * with an ID.
111 */ 112 */
112 struct GNUNET_ARM_Message arm_msg; 113 struct GNUNET_ARM_Message arm_msg;
diff --git a/src/conversation/conversation_api.c b/src/conversation/conversation_api.c
index 9a02811fe..aad272d9c 100644
--- a/src/conversation/conversation_api.c
+++ b/src/conversation/conversation_api.c
@@ -117,7 +117,7 @@ struct GNUNET_CONVERSATION_Caller
117 struct GNUNET_NAMESTORE_QueueEntry *qe; 117 struct GNUNET_NAMESTORE_QueueEntry *qe;
118 118
119 /** 119 /**
120 * Identity of the person calling us (valid while in state #PS_RINGING). 120 * Identity of the person calling us.
121 */ 121 */
122 struct GNUNET_CRYPTO_EcdsaPublicKey caller_id; 122 struct GNUNET_CRYPTO_EcdsaPublicKey caller_id;
123 123
@@ -806,7 +806,7 @@ GNUNET_CONVERSATION_phone_destroy (struct GNUNET_CONVERSATION_Phone *phone)
806 * and the microphone. The call can later be resumed with 806 * and the microphone. The call can later be resumed with
807 * #GNUNET_CONVERSATION_caller_resume. 807 * #GNUNET_CONVERSATION_caller_resume.
808 * 808 *
809 * @param phone phone to pause 809 * @param caller call to suspend
810 */ 810 */
811void 811void
812GNUNET_CONVERSATION_caller_suspend (struct GNUNET_CONVERSATION_Caller *caller) 812GNUNET_CONVERSATION_caller_suspend (struct GNUNET_CONVERSATION_Caller *caller)
@@ -837,7 +837,7 @@ GNUNET_CONVERSATION_caller_suspend (struct GNUNET_CONVERSATION_Caller *caller)
837/** 837/**
838 * Resume suspended conversation of a phone. 838 * Resume suspended conversation of a phone.
839 * 839 *
840 * @param phone phone to resume 840 * @param caller call to resume
841 * @param speaker speaker to use 841 * @param speaker speaker to use
842 * @param mic microphone to use 842 * @param mic microphone to use
843 */ 843 */
diff --git a/src/conversation/conversation_api_call.c b/src/conversation/conversation_api_call.c
index efd6a60de..25e60f0f3 100644
--- a/src/conversation/conversation_api_call.c
+++ b/src/conversation/conversation_api_call.c
@@ -537,10 +537,10 @@ reconnect_call (struct GNUNET_CONVERSATION_Call *call)
537 * @param caller_id identity of the caller 537 * @param caller_id identity of the caller
538 * @param callee GNS name of the callee (used to locate the callee's record) 538 * @param callee GNS name of the callee (used to locate the callee's record)
539 * @param speaker speaker to use (will be used automatically immediately once the 539 * @param speaker speaker to use (will be used automatically immediately once the
540 * #GNUNET_CONVERSATION_EC_READY event is generated); we will NOT generate 540 * #GNUNET_CONVERSATION_EC_CALL_PICKED_UP event is generated); we will NOT generate
541 * a ring tone on the speaker 541 * a ring tone on the speaker
542 * @param mic microphone to use (will be used automatically immediately once the 542 * @param mic microphone to use (will be used automatically immediately once the
543 * #GNUNET_CONVERSATION_EC_READY event is generated) 543 * #GNUNET_CONVERSATION_EC_CALL_PICKED_UP event is generated)
544 * @param event_handler how to notify the owner of the phone about events 544 * @param event_handler how to notify the owner of the phone about events
545 * @param event_handler_cls closure for @a event_handler 545 * @param event_handler_cls closure for @a event_handler
546 */ 546 */
@@ -595,8 +595,6 @@ finish_stop (void *cls)
595 * Terminate a call. The call may be ringing or ready at this time. 595 * Terminate a call. The call may be ringing or ready at this time.
596 * 596 *
597 * @param call call to terminate 597 * @param call call to terminate
598 * @param reason if the call was active (ringing or ready) this will be the
599 * reason given to the other user for why we hung up
600 */ 598 */
601void 599void
602GNUNET_CONVERSATION_call_stop (struct GNUNET_CONVERSATION_Call *call) 600GNUNET_CONVERSATION_call_stop (struct GNUNET_CONVERSATION_Call *call)
@@ -674,14 +672,12 @@ GNUNET_CONVERSATION_call_suspend (struct GNUNET_CONVERSATION_Call *call)
674 672
675 673
676/** 674/**
677 * Resumes a call after #GNUNET_CONVERSATION_call_pause. 675 * Resumes a call after #GNUNET_CONVERSATION_call_suspend.
678 * 676 *
679 * @param call call to resume 677 * @param call call to resume
680 * @param speaker speaker to use (will be used automatically immediately once the 678 * @param speaker speaker to use
681 * #GNUNET_CONVERSATION_EC_READY event is generated); we will NOT generate
682 * a ring tone on the speaker 679 * a ring tone on the speaker
683 * @param mic microphone to use (will be used automatically immediately once the 680 * @param mic microphone to use
684 * #GNUNET_CONVERSATION_EC_READY event is generated)
685 */ 681 */
686void 682void
687GNUNET_CONVERSATION_call_resume (struct GNUNET_CONVERSATION_Call *call, 683GNUNET_CONVERSATION_call_resume (struct GNUNET_CONVERSATION_Call *call,
diff --git a/src/include/gnunet_conversation_service.h b/src/include/gnunet_conversation_service.h
index b5a7fbc9a..cfe4a64ba 100644
--- a/src/include/gnunet_conversation_service.h
+++ b/src/include/gnunet_conversation_service.h
@@ -242,7 +242,7 @@ GNUNET_CONVERSATION_caller_pick_up (struct GNUNET_CONVERSATION_Caller *caller,
242 * and the microphone. The call can later be resumed with 242 * and the microphone. The call can later be resumed with
243 * #GNUNET_CONVERSATION_caller_resume. 243 * #GNUNET_CONVERSATION_caller_resume.
244 * 244 *
245 * @param phone phone to pause 245 * @param caller call to suspend
246 */ 246 */
247void 247void
248GNUNET_CONVERSATION_caller_suspend (struct GNUNET_CONVERSATION_Caller *caller); 248GNUNET_CONVERSATION_caller_suspend (struct GNUNET_CONVERSATION_Caller *caller);
@@ -251,7 +251,7 @@ GNUNET_CONVERSATION_caller_suspend (struct GNUNET_CONVERSATION_Caller *caller);
251/** 251/**
252 * Resume suspended conversation of a phone. 252 * Resume suspended conversation of a phone.
253 * 253 *
254 * @param phone phone to resume 254 * @param caller call to resume
255 * @param speaker speaker to use 255 * @param speaker speaker to use
256 * @param mic microphone to use 256 * @param mic microphone to use
257 */ 257 */
@@ -355,10 +355,10 @@ typedef void (*GNUNET_CONVERSATION_CallEventHandler)(void *cls,
355 * @param caller_id identity of the caller 355 * @param caller_id identity of the caller
356 * @param callee GNS name of the callee (used to locate the callee's record) 356 * @param callee GNS name of the callee (used to locate the callee's record)
357 * @param speaker speaker to use (will be used automatically immediately once the 357 * @param speaker speaker to use (will be used automatically immediately once the
358 * #GNUNET_CONVERSATION_EC_READY event is generated); we will NOT generate 358 * #GNUNET_CONVERSATION_EC_CALL_PICKED_UP event is generated); we will NOT generate
359 * a ring tone on the speaker 359 * a ring tone on the speaker
360 * @param mic microphone to use (will be used automatically immediately once the 360 * @param mic microphone to use (will be used automatically immediately once the
361 * #GNUNET_CONVERSATION_EC_READY event is generated) 361 * #GNUNET_CONVERSATION_EC_CALL_PICKED_UP event is generated)
362 * @param event_handler how to notify the owner of the phone about events 362 * @param event_handler how to notify the owner of the phone about events
363 * @param event_handler_cls closure for @a event_handler 363 * @param event_handler_cls closure for @a event_handler
364 */ 364 */
@@ -383,14 +383,11 @@ GNUNET_CONVERSATION_call_suspend (struct GNUNET_CONVERSATION_Call *call);
383 383
384 384
385/** 385/**
386 * Resumes a call after #GNUNET_CONVERSATION_call_pause. 386 * Resumes a call after #GNUNET_CONVERSATION_call_suspend.
387 * 387 *
388 * @param call call to resume 388 * @param call call to resume
389 * @param speaker speaker to use (will be used automatically immediately once the 389 * @param speaker speaker to use
390 * #GNUNET_CONVERSATION_EC_READY event is generated); we will NOT generate 390 * @param mic microphone to use
391 * a ring tone on the speaker
392 * @param mic microphone to use (will be used automatically immediately once the
393 * #GNUNET_CONVERSATION_EC_READY event is generated)
394 */ 391 */
395void 392void
396GNUNET_CONVERSATION_call_resume (struct GNUNET_CONVERSATION_Call *call, 393GNUNET_CONVERSATION_call_resume (struct GNUNET_CONVERSATION_Call *call,