[GNUnet-SVN] r33480 - in gnunet/src: conversation include

[gnunet]

Author: grothoff
Date: 2014-06-02 22:12:20 +0200 (Mon, 02 Jun 2014)
New Revision: 33480

Modified:
   gnunet/src/conversation/conversation.conf.in
   gnunet/src/include/gnunet_conversation_service.h
   gnunet/src/include/gnunet_dnsparser_lib.h
   gnunet/src/include/gnunet_gnsrecord_lib.h
   gnunet/src/include/gnunet_namestore_service.h
Log:
-doxygen, indentation

Modified: gnunet/src/conversation/conversation.conf.in
===================================================================
--- gnunet/src/conversation/conversation.conf.in        2014-06-02 20:09:10 UTC 
(rev 33479)
+++ gnunet/src/conversation/conversation.conf.in        2014-06-02 20:12:20 UTC 
(rev 33480)
@@ -4,8 +4,24 @@
 UNIXPATH = $GNUNET_RUNTIME_DIR/gnunet-service-conversation.sock
 HOSTNAME = localhost
 @UNIXONLY@ PORT = 2106
+
+# Desired phone line.  Change if multiple users are using
+# the same peer and we thus need disjoint phone lines.
 LINE = 1
 
+# Should the phone record be private? (only set to YES if
+# you really know what you are doing, you will then likely
+# not be able to receive calls).
+RECORD_IS_PRIVATE = NO
+
+# How long should phone records remain published in GNS?
+# A long expiration time has the advantage that the phone
+# is more likely found and/or resolved faster, OTOH it
+# then takes longer to change the phone line if necessary.
+# The default should be fine for most users.
+RECORD_EXPIRATION = 1 day
+
+
 ACCEPT_FROM = 127.0.0.1;
 ACCEPT_FROM6 = ::1;
 UNIX_MATCH_UID = NO

Modified: gnunet/src/include/gnunet_conversation_service.h
===================================================================
--- gnunet/src/include/gnunet_conversation_service.h    2014-06-02 20:09:10 UTC 
(rev 33479)
+++ gnunet/src/include/gnunet_conversation_service.h    2014-06-02 20:12:20 UTC 
(rev 33480)
@@ -368,6 +368,7 @@
  *        #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
+ * @return handle for the call
  */
 struct GNUNET_CONVERSATION_Call *
 GNUNET_CONVERSATION_call_start (const struct GNUNET_CONFIGURATION_Handle *cfg,

Modified: gnunet/src/include/gnunet_dnsparser_lib.h
===================================================================
--- gnunet/src/include/gnunet_dnsparser_lib.h   2014-06-02 20:09:10 UTC (rev 
33479)
+++ gnunet/src/include/gnunet_dnsparser_lib.h   2014-06-02 20:12:20 UTC (rev 
33480)
@@ -66,7 +66,7 @@
   /**
    * Name of the record that the query is for (0-terminated).
    * In UTF-8 format.  The library will convert from and to DNS-IDNA
-   * as necessary.  Use 'GNUNET_DNSPARSER_check_label' to test if an
+   * as necessary.  Use #GNUNET_DNSPARSER_check_label() to test if an
    * individual label is well-formed.  If a given name is not well-formed,
    * creating the DNS packet will fail.
    */
@@ -99,7 +99,7 @@
   /**
    * Name of the mail server.
    * In UTF-8 format.  The library will convert from and to DNS-IDNA
-   * as necessary.  Use 'GNUNET_DNSPARSER_check_label' to test if an
+   * as necessary.  Use #GNUNET_DNSPARSER_check_label() to test if an
    * individual label is well-formed.  If a given name is not well-formed,
    * creating the DNS packet will fail.
    */
@@ -112,7 +112,7 @@
  * Information from SRV records (RFC 2782).  The 'service', 'proto'
  * and 'domain_name' fields together give the DNS-name which for SRV
  * records is of the form "_$SERVICE._$PROTO.$DOMAIN_NAME".  The DNS
- * parser provides the full name in 'struct DNSPARSER_Record' and the
+ * parser provides the full name in `struct DNSPARSER_Record` and the
  * individual components in the respective fields of this struct.
  * When serializing, you CAN set the 'name' field of 'struct
  * GNUNET_DNSPARSER_Record' to NULL, in which case the DNSPARSER code
@@ -126,7 +126,7 @@
    * Service name without the underscore (!).  Note that RFC 6335 clarifies the
    * set of legal characters for service names.
    * In UTF-8 format.  The library will convert from and to DNS-IDNA
-   * as necessary.  Use 'GNUNET_DNSPARSER_check_label' to test if an
+   * as necessary.  Use #GNUNET_DNSPARSER_check_label() to test if an
    * individual label is well-formed.  If a given name is not well-formed,
    * creating the DNS packet will fail.
    */
@@ -141,7 +141,7 @@
   /**
    * Domain name for which the record is valid
    * In UTF-8 format.  The library will convert from and to DNS-IDNA
-   * as necessary.  Use 'GNUNET_DNSPARSER_check_label' to test if an
+   * as necessary.  Use #GNUNET_DNSPARSER_check_label() to test if an
    * individual label is well-formed.  If a given name is not well-formed,
    * creating the DNS packet will fail.
    */
@@ -150,7 +150,7 @@
   /**
    * Hostname offering the service.
    * In UTF-8 format.  The library will convert from and to DNS-IDNA
-   * as necessary.  Use 'GNUNET_DNSPARSER_check_label' to test if an
+   * as necessary.  Use #GNUNET_DNSPARSER_check_label() to test if an
    * individual label is well-formed.  If a given name is not well-formed,
    * creating the DNS packet will fail.
    */
@@ -353,7 +353,7 @@
    * The domainname of the name server that was the
    * original or primary source of data for this zone.
    * In UTF-8 format.  The library will convert from and to DNS-IDNA
-   * as necessary.  Use #GNUNET_DNSPARSER_check_label to test if an
+   * as necessary.  Use #GNUNET_DNSPARSER_check_label() to test if an
    * individual label is well-formed.  If a given name is not well-formed,
    * creating the DNS packet will fail.
    */
@@ -363,7 +363,7 @@
    * A domainname which specifies the mailbox of the
    * person responsible for this zone.
    * In UTF-8 format.  The library will convert from and to DNS-IDNA
-   * as necessary.  Use 'GNUNET_DNSPARSER_check_label' to test if an
+   * as necessary.  Use #GNUNET_DNSPARSER_check_label() to test if an
    * individual label is well-formed.  If a given name is not well-formed,
    * creating the DNS packet will fail.
    */
@@ -427,7 +427,7 @@
   /**
    * Name of the record that the query is for (0-terminated).
    * In UTF-8 format.  The library will convert from and to DNS-IDNA
-   * as necessary.  Use #GNUNET_DNSPARSER_check_label to test if an
+   * as necessary.  Use #GNUNET_DNSPARSER_check_label() to test if an
    * individual label is well-formed.  If a given name is not well-formed,
    * creating the DNS packet will fail.
    */
@@ -442,7 +442,7 @@
     /**
      * For NS, CNAME and PTR records, this is the uncompressed 0-terminated 
hostname.
    * In UTF-8 format.  The library will convert from and to DNS-IDNA
-   * as necessary.  Use #GNUNET_DNSPARSER_check_label to test if an
+   * as necessary.  Use #GNUNET_DNSPARSER_check_label() to test if an
    * individual label is well-formed.  If a given name is not well-formed,
    * creating the DNS packet will fail.
      */

Modified: gnunet/src/include/gnunet_gnsrecord_lib.h
===================================================================
--- gnunet/src/include/gnunet_gnsrecord_lib.h   2014-06-02 20:09:10 UTC (rev 
33479)
+++ gnunet/src/include/gnunet_gnsrecord_lib.h   2014-06-02 20:12:20 UTC (rev 
33480)
@@ -146,13 +146,13 @@
 
   /**
    * Expiration time for the DNS record.  Can be relative
-   * or absolute, depending on 'flags'.  Measured in the same
+   * or absolute, depending on @e flags.  Measured in the same
    * unit as GNUnet time (microseconds).
    */
   uint64_t expiration_time;
 
   /**
-   * Number of bytes in 'data'.
+   * Number of bytes in @e data.
    */
   size_t data_size;
 

Modified: gnunet/src/include/gnunet_namestore_service.h
===================================================================
--- gnunet/src/include/gnunet_namestore_service.h       2014-06-02 20:09:10 UTC 
(rev 33479)
+++ gnunet/src/include/gnunet_namestore_service.h       2014-06-02 20:12:20 UTC 
(rev 33480)
@@ -89,9 +89,10 @@
  *                #GNUNET_YES (or other positive value) on success
  * @param emsg NULL on success, otherwise an error message
  */
-typedef void (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
-                                                         int32_t success,
-                                                         const char *emsg);
+typedef void
+(*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
+                                            int32_t success,
+                                            const char *emsg);
 
 
 /**
@@ -128,12 +129,14 @@
  * @param rd_count number of entries in @a rd array, 0 if label was deleted
  * @param rd array of records with data to store
  */
-typedef void (*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
-                                               const struct 
GNUNET_CRYPTO_EcdsaPrivateKey *zone,
-                                               const char *label,
-                                               unsigned int rd_count,
-                                               const struct 
GNUNET_GNSRECORD_Data *rd);
+typedef void
+(*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
+                                   const struct GNUNET_CRYPTO_EcdsaPrivateKey 
*zone,
+                                   const char *label,
+                                   unsigned int rd_count,
+                                   const struct GNUNET_GNSRECORD_Data *rd);
 
+
 /**
  * Set the desired nick name for a zone
  *
@@ -259,7 +262,8 @@
  *
  * @param cls closure
  */
-typedef void (*GNUNET_NAMESTORE_RecordsSynchronizedCallback)(void *cls);
+typedef void
+(*GNUNET_NAMESTORE_RecordsSynchronizedCallback)(void *cls);
 
 
 /**