Merge remote-tracking branch 'origin/master' into identity_abe

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

diff --git a/src/include/gnunet_friends_lib.h b/src/include/gnunet_friends_lib.h
index dda1d324524cddcca05d1fcf175ce2b07d199322..2e111780ec4dffac7ffa363a9c10fb5c703339eb 100644 (file)
--- a/src/include/gnunet_friends_lib.h
+++ b/src/include/gnunet_friends_lib.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2013 Christian Grothoff
+     Copyright (C) 2013 Christian Grothoff
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,18 +14,31 @@
 
      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_friends_lib.h
- * @brief library to read and write the FRIENDS file
  * @author Christian Grothoff
+ *
+ * @file
+ * Library to read and write the FRIENDS file
+ *
+ * @defgroup friends  Friends library
+ * Library to read and write the FRIENDS file
+ * @{
  */
 #ifndef GNUNET_FRIENDS_LIB_H
 #define GNUNET_FRIENDS_LIB_H
 
+#ifdef __cplusplus
+extern "C"
+{
+#if 0                           /* keep Emacsens' auto-indent happy */
+}
+#endif
+#endif
+
 #include "gnunet_util_lib.h"
 
 
@@ -33,10 +46,10 @@
  * Signature of a function called on each friend found.
  *
  * @param cls closure
- * @param friend peer identity of the friend
+ * @param friend_id peer identity of the friend
  */
 typedef void (*GNUNET_FRIENDS_Callback)(void *cls,
-                                        const struct GNUNET_PeerIdentity *friend);
+                                        const struct GNUNET_PeerIdentity *friend_id);
 
 
 /**
@@ -84,12 +97,21 @@ GNUNET_FRIENDS_write_stop (struct GNUNET_FRIENDS_Writer *w);
  * Add a friend to the friends file.
  *
  * @param w write handle
- * @param friend friend to add
+ * @param friend_id friend to add
  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
  */
 int
 GNUNET_FRIENDS_write (struct GNUNET_FRIENDS_Writer *w,
-                      const struct GNUNET_PeerIdentity *friend);
+                      const struct GNUNET_PeerIdentity *friend_id);
 
 
+#if 0                           /* keep Emacsens' auto-indent happy */
+{
 #endif
+#ifdef __cplusplus
+}
+#endif
+
+#endif
+
+/** @} */  /* end of group */