RECLAIM/OIDC: code cleanup

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

diff --git a/src/include/gnunet_core_service.h b/src/include/gnunet_core_service.h
index ace223c1122225df02d2603fde4fb1869a2bf322..f10ddee75eb14b167632f1ee88f2ddf92818e98a 100644 (file)
--- a/src/include/gnunet_core_service.h
+++ b/src/include/gnunet_core_service.h
@@ -2,20 +2,20 @@
      This file is part of GNUnet.
      Copyright (C) 2009-2017 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
-     by the Free Software Foundation; either version 3, or (at your
-     option) any later version.
+     GNUnet is free software: you can redistribute it and/or modify it
+     under the terms of the GNU Affero General Public License as published
+     by the Free Software Foundation, either version 3 of the License,
+     or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-     General Public License for more details.
+     Affero General Public License for more details.
+    
+     You should have received a copy of the GNU Affero General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-     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., 51 Franklin Street, Fifth Floor,
-     Boston, MA 02110-1301, USA.
+     SPDX-License-Identifier: AGPL3.0-or-later
 */
 /**
  * @author Christian Grothoff
@@ -90,6 +90,8 @@ struct GNUNET_CORE_Handle;
  *
  * @param cls closure
  * @param peer peer identity this notification is about
+ * @return closure associated with @a peer. given to mq callbacks and
+ *         #GNUNET_CORE_DisconnectEventHandler
  */
 typedef void *
 (*GNUNET_CORE_ConnectEventHandler) (void *cls,
@@ -102,6 +104,8 @@ typedef void *
  *
  * @param cls closure
  * @param peer peer identity this notification is about
+ * @param peer_cls closure associated with peer. given in
+ *        #GNUNET_CORE_ConnectEventHandler
  */
 typedef void
 (*GNUNET_CORE_DisconnectEventHandler) (void *cls,
@@ -220,7 +224,7 @@ enum GNUNET_CORE_KxState
   /**
    * No handshake yet.
    */
-  GNUNET_CORE_KX_STATE_DOWN,
+  GNUNET_CORE_KX_STATE_DOWN = 0,
 
   /**
    * We've sent our session key.
@@ -234,7 +238,7 @@ enum GNUNET_CORE_KxState
 
   /**
    * The other peer has confirmed our session key + PING with a PONG
-   * message encrypted with his session key (which we got).  Key
+   * message encrypted with their session key (which we got).  Key
    * exchange is done.
    */
   GNUNET_CORE_KX_STATE_UP,