convert fs publish to MQ

[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 7b039ed9964fd72302cd6ab89d8f4fc9b70d162a..e8709d0f13167307eb088248d9a8eae92c760712 100644 (file)
--- a/src/include/gnunet_core_service.h
+++ b/src/include/gnunet_core_service.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (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,19 +14,22 @@
 
      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_core_service.h
- * @brief core service; this is the main API for encrypted P2P
- *        communications
  * @author Christian Grothoff
- * @defgroup core encrypted direct communication between peers
+ *
+ * @file include/gnunet_core_service.h
+ * Core service; the main API for encrypted P2P communications
+ *
+ * @defgroup core  Core service
+ * Encrypted direct communication between peers
+ *
+ * @see [Documentation](https://gnunet.org/gnunet-core-subsystem)
+ *
  * @{
  */
-
 #ifndef GNUNET_CORE_SERVICE_H
 #define GNUNET_CORE_SERVICE_H
 
@@ -245,7 +248,7 @@ struct GNUNET_CORE_TransmitHandle;
  * established (and the client has been informed about this).  You may
  * have one request of this type pending for each connected peer at
  * any time.  If a peer disconnects, the application MUST call
- * #GNUNET_CORE_notify_transmit_ready_cancel on the respective
+ * #GNUNET_CORE_notify_transmit_ready_cancel() on the respective
  * transmission request, if one such request is pending.
  *
  * @param handle connection to core service
@@ -253,7 +256,7 @@ struct GNUNET_CORE_TransmitHandle;
  * @param priority how important is the message?
  * @param maxdelay how long can the message wait? Only effective if @a cork is #GNUNET_YES
  * @param target who should receive the message, never NULL (can be this peer's identity for loopback)
- * @param notify_size how many bytes of buffer space does notify want?
+ * @param notify_size how many bytes of buffer space does @a notify want?
  * @param notify function to call when buffer space is available;
  *        will be called with NULL on timeout; clients MUST cancel
  *        all pending transmission requests DURING the disconnect
@@ -261,7 +264,7 @@ struct GNUNET_CORE_TransmitHandle;
  * @param notify_cls closure for @a notify
  * @return non-NULL if the notify callback was queued,
  *         NULL if we can not even queue the request (request already pending);
- *         if NULL is returned, "notify" will NOT be called.
+ *         if NULL is returned, @a notify will NOT be called.
  */
 struct GNUNET_CORE_TransmitHandle *
 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle,
@@ -277,7 +280,7 @@ GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle,
 /**
  * Cancel the specified transmission-ready notification.
  *
- * @param th handle that was returned by "notify_transmit_ready".
+ * @param th handle that was returned by #GNUNET_CORE_notify_transmit_ready().
  */
 void
 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle *th);
@@ -450,8 +453,9 @@ GNUNET_CORE_mq_create (struct GNUNET_CORE_Handle *h,
 }
 #endif
 
-/** @} */ /* end of group core */
-
 /* ifndef GNUNET_CORE_SERVICE_H */
 #endif
+
+/** @} */  /* end of group core */
+
 /* end of gnunet_core_service.h */