Update jsonapi to current specs, refactor
[oweals/gnunet.git] / src / include / gnunet_identity_service.h
index fe1e4d20614bf86a3d455da9a6cdd83329d74642..e07951de7dbbd1b390f75515383c60fb978b751a 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2013 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2013 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
 
      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_identity_service.h
- * @brief Identity service; implements identity management for GNUnet
  * @author Christian Grothoff
  *
- * Identities in GNUnet are ECDSA keys.  You assume an identity by
- * using (signing with) a particular private key.  As GNUnet users are
- * expected to have many egos, we need an identity service to
- * allow users to manage their egos.  The identity service
- * manages the egos (private keys) of the local user; it does
- * NOT manage identities of other users (public keys).  For giving
- * names to other users and manage their public keys securely, we
- * use GNS.
+ * @file
+ * Identity service; implements identity management for GNUnet
+ *
+ * @defgroup identity  Identity service
+ * Identity management.
+ *
+ * Egos in GNUnet are ECDSA keys.  You assume an ego by using (signing
+ * with) a particular private key.  As GNUnet users are expected to
+ * have many egos, we need an identity service to allow users to
+ * manage their egos.  The identity service manages the egos (private
+ * keys) of the local user; it does NOT manage egos of other users
+ * (public keys).  For giving names to other users and manage their
+ * public keys securely, we use GNS.
+ *
+ * @see [Documentation](https://gnunet.org/identity-subsystem)
  *
- * @defgroup identity identity management service
  * @{
  */
 #ifndef GNUNET_IDENTITY_SERVICE_H
@@ -135,10 +139,11 @@ GNUNET_IDENTITY_ego_get_public_key (const struct GNUNET_IDENTITY_Ego *ego,
  *                   NULL if the user just deleted the ego and it
  *                   must thus no longer be used
  */
-typedef void (*GNUNET_IDENTITY_Callback)(void *cls,
-                                        struct GNUNET_IDENTITY_Ego *ego,
-                                        void **ctx,
-                                        const char *name);
+typedef void
+(*GNUNET_IDENTITY_Callback)(void *cls,
+                            struct GNUNET_IDENTITY_Ego *ego,
+                            void **ctx,
+                            const char *name);
 
 
 /**
@@ -179,8 +184,9 @@ GNUNET_IDENTITY_get (struct GNUNET_IDENTITY_Handle *id,
  * @param cls closure
  * @param emsg NULL on success, otherwise an error message
  */
-typedef void (*GNUNET_IDENTITY_Continuation)(void *cls,
-                                            const char *emsg);
+typedef void
+(*GNUNET_IDENTITY_Continuation)(void *cls,
+                                const char *emsg);
 
 
 /**
@@ -280,8 +286,9 @@ GNUNET_IDENTITY_cancel (struct GNUNET_IDENTITY_Operation *op);
  * @param cls closure
  * @param ego NULL on error / ego not found
  */
-typedef void (*GNUNET_IDENTITY_EgoCallback)(void *cls,
-                                           const struct GNUNET_IDENTITY_Ego *ego);
+typedef void
+(*GNUNET_IDENTITY_EgoCallback)(void *cls,
+                               const struct GNUNET_IDENTITY_Ego *ego);
 
 /**
  * Handle for ego lookup.
@@ -321,8 +328,9 @@ GNUNET_IDENTITY_ego_lookup_cancel (struct GNUNET_IDENTITY_EgoLookup *el);
 }
 #endif
 
-/** @} */ /* end of group identity */
-
 /* ifndef GNUNET_IDENTITY_SERVICE_H */
 #endif
+
+/** @} */ /* end of group identity */
+
 /* end of gnunet_identity_service.h */