-cleanup doc; fixes
[oweals/gnunet.git] / src / include / gnunet_rest_plugin.h
index e1eabd813e392af1f6cc2d7bdc12b78fb15529ec..424dbb1fc33b0c84eed5c1a2a83207995b30334d 100644 (file)
@@ -1,6 +1,6 @@
 /*
    This file is part of GNUnet.
-   Copyright (C) 2012-2015 Christian Grothoff (and other contributing authors)
+   Copyright (C) 2012-2015 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.
    */
 /**
  * @author Martin Schanzenbach
- * @file include/gnunet_rest_plugin.h
- * @brief GNUnet service REST plugin header
  *
+ * @file
+ * GNUnet service REST plugin header
+ *
+ * @defgroup rest-plugin  REST plugin for GNUnet services
+ * @{
  */
 #ifndef GNUNET_REST_PLUGIN_H
 #define GNUNET_REST_PLUGIN_H
@@ -54,13 +57,13 @@ struct GNUNET_REST_Plugin
 
   /**
    * Plugin name. Used as the namespace for the API.
-   * e.g. http://hostname:port/<name>
+   * e.g. http://hostname:port/name
    */
   char *name;
 
   /**
    * Function to process a REST call
-   * 
+   *
    * @param method the HTTP method called
    * @param url the relative url accessed
    * @param data the REST data (can be NULL)
@@ -68,7 +71,7 @@ struct GNUNET_REST_Plugin
    * @param proc the callback for result
    * @param proc_cls closure for callback
    */
-  void (*process_request) (struct RestConnectionDataHandle *handle,
+  void (*process_request) (struct GNUNET_REST_RequestHandle *handle,
                            GNUNET_REST_ResultProcessor proc,
                            void *proc_cls);
 
@@ -82,6 +85,6 @@ struct GNUNET_REST_Plugin
 }
 #endif
 
-/* end of gnunet_rest_plugin.h */
 #endif
 
+/** @} */  /* end of group */