multicast, psyc, psycstore, client_manager fixes

[oweals/gnunet.git] / src / include / gnunet_regex_service.h

diff --git a/src/include/gnunet_regex_service.h b/src/include/gnunet_regex_service.h
index 2a176f401dd5ce1d9c6acb16d16a7b7b81a1ea37..15e86610cdda92d8f32ecdcf2aa305a2cfff71cb 100644 (file)
--- a/src/include/gnunet_regex_service.h
+++ b/src/include/gnunet_regex_service.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet
-     (C) 2012, 2013 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2012, 2013 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,8 +14,8 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 /**
  * @file include/gnunet_regex_service.h
@@ -56,21 +56,19 @@ struct GNUNET_REGEX_Search;
 
 
 /**
- * Announce the given peer under the given regular expression.  Does
- * not free resources, must call GNUNET_REGEX_announce_cancel for
+ * Announce this peer under the given regular expression.  Does
+ * not free resources, must call #GNUNET_REGEX_announce_cancel for
  * that.
- * 
+ *
  * @param cfg configuration to use
- * @param id ID to announce as provider of regex. Own ID in most cases.
  * @param regex Regular expression to announce.
  * @param refresh_delay after what delay should the announcement be repeated?
  * @param compression How many characters per edge can we squeeze?
  * @return Handle to reuse o free cached resources.
- *         Must be freed by calling GNUNET_REGEX_announce_cancel.
+ *         Must be freed by calling #GNUNET_REGEX_announce_cancel.
  */
 struct GNUNET_REGEX_Announcement *
 GNUNET_REGEX_announce (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                      const struct GNUNET_PeerIdentity *id,
                        const char *regex,
                       struct GNUNET_TIME_Relative refresh_delay,
                        uint16_t compression);
@@ -78,8 +76,8 @@ GNUNET_REGEX_announce (const struct GNUNET_CONFIGURATION_Handle *cfg,
 
 /**
  * Stop announcing the regex specified by the given handle.
- * 
- * @param a handle returned by a previous GNUNET_REGEX_announce call.
+ *
+ * @param a handle returned by a previous #GNUNET_REGEX_announce call.
  */
 void
 GNUNET_REGEX_announce_cancel (struct GNUNET_REGEX_Announcement *a);
@@ -88,12 +86,12 @@ GNUNET_REGEX_announce_cancel (struct GNUNET_REGEX_Announcement *a);
 /**
  * Search callback function, invoked for every result that was found.
  *
- * @param cls Closure provided in GNUNET_REGEX_search.
+ * @param cls Closure provided in #GNUNET_REGEX_search.
  * @param id Peer providing a regex that matches the string.
  * @param get_path Path of the get request.
- * @param get_path_length Lenght of get_path.
+ * @param get_path_length Lenght of @a get_path.
  * @param put_path Path of the put request.
- * @param put_path_length Length of the put_path.
+ * @param put_path_length Length of the @a put_path.
  */
 typedef void (*GNUNET_REGEX_Found)(void *cls,
                                    const struct GNUNET_PeerIdentity *id,
@@ -105,7 +103,7 @@ typedef void (*GNUNET_REGEX_Found)(void *cls,
 
 /**
  * Search for a peer offering a regex matching certain string in the DHT.
- * The search runs until GNUNET_REGEX_search_cancel is called, even if results
+ * The search runs until #GNUNET_REGEX_search_cancel is called, even if results
  * are returned.
  *
  * @param cfg configuration to use
@@ -113,7 +111,7 @@ typedef void (*GNUNET_REGEX_Found)(void *cls,
  * @param callback Callback for found peers.
  * @param callback_cls Closure for @c callback.
  * @return Handle to stop search and free resources.
- *         Must be freed by calling GNUNET_REGEX_search_cancel.
+ *         Must be freed by calling #GNUNET_REGEX_search_cancel.
  */
 struct GNUNET_REGEX_Search *
 GNUNET_REGEX_search (const struct GNUNET_CONFIGURATION_Handle *cfg,
@@ -123,9 +121,9 @@ GNUNET_REGEX_search (const struct GNUNET_CONFIGURATION_Handle *cfg,
 
 
 /**
- * Stop search and free all data used by a GNUNET_REGEX_search call.
- * 
- * @param h Handle returned by a previous GNUNET_REGEX_search call.
+ * Stop search and free all data used by a #GNUNET_REGEX_search call.
+ *
+ * @param s Handle returned by a previous #GNUNET_REGEX_search call.
  */
 void
 GNUNET_REGEX_search_cancel (struct GNUNET_REGEX_Search *s);