convert fs publish to MQ

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

diff --git a/src/include/gnunet_cadet_service.h b/src/include/gnunet_cadet_service.h
index 6788fc232f5b8e333c9d5b3ca0497601ec4c1e04..264bc315401d5ec5b15f15d673dbd4abf2bf72c0 100644 (file)
--- a/src/include/gnunet_cadet_service.h
+++ b/src/include/gnunet_cadet_service.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     Copyright (C) 2009-2014 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2009-2014 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
@@ -14,14 +14,23 @@
 
      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_cadet_service.h
- * @brief cadet service; establish channels to distant peers
  * @author Christian Grothoff
  * @author Bart Polot
+ *
+ * @file
+ * CADET service; establish channels to distant peers
+ *
+ * @defgroup cadet  CADET service
+ * Confidential Ad-hoc Decentralized End-to-End Transport
+ *
+ * @see [Documentation](https://gnunet.org/cadet-subsystem)
+ * @see [Paper](https://gnunet.org/cadet)
+ *
+ * @{
  */
 #ifndef GNUNET_CADET_SERVICE_H
 #define GNUNET_CADET_SERVICE_H
@@ -420,7 +429,7 @@ typedef void
  * @param neighbor Is this a direct neighbor? #GNUNET_YES/#GNUNET_NO
  * @param n_paths Number of paths known towards peer.
  * @param paths Array of PEER_IDs representing all paths to reach the peer.
- *              Each path starts with the local peer.
+ *              Each path starts with the first hop (local peer not included).
  *              Each path ends with the destination peer (given in @c peer).
  */
 typedef void
@@ -634,4 +643,7 @@ GNUNET_CADET_mq_create (struct GNUNET_CADET_Channel *channel);
 
 /* ifndef GNUNET_CADET_SERVICE_H */
 #endif
+
+/** @} */  /* end of group */
+
 /* end of gnunet_cadet_service.h */