[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] r30741 - in gnunet/src: arm conversation include
From: |
gnunet |
Subject: |
[GNUnet-SVN] r30741 - in gnunet/src: arm conversation include |
Date: |
Sat, 16 Nov 2013 12:28:31 +0100 |
Author: grothoff
Date: 2013-11-16 12:28:31 +0100 (Sat, 16 Nov 2013)
New Revision: 30741
Modified:
gnunet/src/arm/arm.h
gnunet/src/conversation/conversation_api.c
gnunet/src/conversation/conversation_api_call.c
gnunet/src/include/gnunet_conversation_service.h
Log:
-doxygen fixes
Modified: gnunet/src/arm/arm.h
===================================================================
--- gnunet/src/arm/arm.h 2013-11-15 23:03:32 UTC (rev 30740)
+++ gnunet/src/arm/arm.h 2013-11-16 11:28:31 UTC (rev 30741)
@@ -60,11 +60,12 @@
* Reply to client, type is #GNUNET_MESSAGE_TYPE_ARM_RESULT or
* #GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT.
* OR
- * Request from client, type is #GNUNET_MESSAGE_TYPE_ARM_REQUEST
+ * Request from client, type is #GNUNET_MESSAGE_TYPE_ARM_START or
+ * #GNUNET_MESSAGE_TYPE_ARM_STOP.
*/
struct GNUNET_MessageHeader header;
- /**
+ /**
* For alignment.
*/
uint32_t reserved;
@@ -87,12 +88,12 @@
{
/**
- * Reply to client, of type is GNUNET_MESSAGE_TYPE_ARM_RESULT, with an ID.
+ * Reply to client, of type is #GNUNET_MESSAGE_TYPE_ARM_RESULT, with an ID.
*/
struct GNUNET_ARM_Message arm_msg;
/**
- * Result from the 'enum GNUNET_ARM_Result'
+ * Result from the `enum GNUNET_ARM_Result`
*/
uint32_t result;
};
@@ -106,7 +107,7 @@
struct GNUNET_ARM_ListResultMessage
{
/**
- * Reply to client, of type is GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT,
+ * Reply to client, of type is #GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT,
* with an ID.
*/
struct GNUNET_ARM_Message arm_msg;
Modified: gnunet/src/conversation/conversation_api.c
===================================================================
--- gnunet/src/conversation/conversation_api.c 2013-11-15 23:03:32 UTC (rev
30740)
+++ gnunet/src/conversation/conversation_api.c 2013-11-16 11:28:31 UTC (rev
30741)
@@ -117,7 +117,7 @@
struct GNUNET_NAMESTORE_QueueEntry *qe;
/**
- * Identity of the person calling us (valid while in state #PS_RINGING).
+ * Identity of the person calling us.
*/
struct GNUNET_CRYPTO_EcdsaPublicKey caller_id;
@@ -806,7 +806,7 @@
* and the microphone. The call can later be resumed with
* #GNUNET_CONVERSATION_caller_resume.
*
- * @param phone phone to pause
+ * @param caller call to suspend
*/
void
GNUNET_CONVERSATION_caller_suspend (struct GNUNET_CONVERSATION_Caller *caller)
@@ -837,7 +837,7 @@
/**
* Resume suspended conversation of a phone.
*
- * @param phone phone to resume
+ * @param caller call to resume
* @param speaker speaker to use
* @param mic microphone to use
*/
Modified: gnunet/src/conversation/conversation_api_call.c
===================================================================
--- gnunet/src/conversation/conversation_api_call.c 2013-11-15 23:03:32 UTC
(rev 30740)
+++ gnunet/src/conversation/conversation_api_call.c 2013-11-16 11:28:31 UTC
(rev 30741)
@@ -537,10 +537,10 @@
* @param caller_id identity of the caller
* @param callee GNS name of the callee (used to locate the callee's record)
* @param speaker speaker to use (will be used automatically immediately once
the
- * #GNUNET_CONVERSATION_EC_READY event is generated); we will NOT
generate
+ * #GNUNET_CONVERSATION_EC_CALL_PICKED_UP event is generated); we will
NOT generate
* a ring tone on the speaker
* @param mic microphone to use (will be used automatically immediately once
the
- * #GNUNET_CONVERSATION_EC_READY event is generated)
+ * #GNUNET_CONVERSATION_EC_CALL_PICKED_UP event is generated)
* @param event_handler how to notify the owner of the phone about events
* @param event_handler_cls closure for @a event_handler
*/
@@ -595,8 +595,6 @@
* Terminate a call. The call may be ringing or ready at this time.
*
* @param call call to terminate
- * @param reason if the call was active (ringing or ready) this will be the
- * reason given to the other user for why we hung up
*/
void
GNUNET_CONVERSATION_call_stop (struct GNUNET_CONVERSATION_Call *call)
@@ -674,14 +672,12 @@
/**
- * Resumes a call after #GNUNET_CONVERSATION_call_pause.
+ * Resumes a call after #GNUNET_CONVERSATION_call_suspend.
*
* @param call call to resume
- * @param speaker speaker to use (will be used automatically immediately once
the
- * #GNUNET_CONVERSATION_EC_READY event is generated); we will NOT
generate
+ * @param speaker speaker to use
* a ring tone on the speaker
- * @param mic microphone to use (will be used automatically immediately once
the
- * #GNUNET_CONVERSATION_EC_READY event is generated)
+ * @param mic microphone to use
*/
void
GNUNET_CONVERSATION_call_resume (struct GNUNET_CONVERSATION_Call *call,
Modified: gnunet/src/include/gnunet_conversation_service.h
===================================================================
--- gnunet/src/include/gnunet_conversation_service.h 2013-11-15 23:03:32 UTC
(rev 30740)
+++ gnunet/src/include/gnunet_conversation_service.h 2013-11-16 11:28:31 UTC
(rev 30741)
@@ -242,7 +242,7 @@
* and the microphone. The call can later be resumed with
* #GNUNET_CONVERSATION_caller_resume.
*
- * @param phone phone to pause
+ * @param caller call to suspend
*/
void
GNUNET_CONVERSATION_caller_suspend (struct GNUNET_CONVERSATION_Caller *caller);
@@ -251,7 +251,7 @@
/**
* Resume suspended conversation of a phone.
*
- * @param phone phone to resume
+ * @param caller call to resume
* @param speaker speaker to use
* @param mic microphone to use
*/
@@ -355,10 +355,10 @@
* @param caller_id identity of the caller
* @param callee GNS name of the callee (used to locate the callee's record)
* @param speaker speaker to use (will be used automatically immediately once
the
- * #GNUNET_CONVERSATION_EC_READY event is generated); we will NOT
generate
+ * #GNUNET_CONVERSATION_EC_CALL_PICKED_UP event is generated); we will
NOT generate
* a ring tone on the speaker
* @param mic microphone to use (will be used automatically immediately once
the
- * #GNUNET_CONVERSATION_EC_READY event is generated)
+ * #GNUNET_CONVERSATION_EC_CALL_PICKED_UP event is generated)
* @param event_handler how to notify the owner of the phone about events
* @param event_handler_cls closure for @a event_handler
*/
@@ -383,14 +383,11 @@
/**
- * Resumes a call after #GNUNET_CONVERSATION_call_pause.
+ * Resumes a call after #GNUNET_CONVERSATION_call_suspend.
*
* @param call call to resume
- * @param speaker speaker to use (will be used automatically immediately once
the
- * #GNUNET_CONVERSATION_EC_READY event is generated); we will NOT
generate
- * a ring tone on the speaker
- * @param mic microphone to use (will be used automatically immediately once
the
- * #GNUNET_CONVERSATION_EC_READY event is generated)
+ * @param speaker speaker to use
+ * @param mic microphone to use
*/
void
GNUNET_CONVERSATION_call_resume (struct GNUNET_CONVERSATION_Call *call,
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNUnet-SVN] r30741 - in gnunet/src: arm conversation include,
gnunet <=