X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_rest_plugin.h;h=54eeb902df6d6822340ee2e433ca0379298eb256;hb=200d05b44a96d6fec00e28736038c838c679f650;hp=e1eabd813e392af1f6cc2d7bdc12b78fb15529ec;hpb=44a92cf5418bab5de485a25fc3894bb33f6a7b96;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_rest_plugin.h b/src/include/gnunet_rest_plugin.h index e1eabd813..54eeb902d 100644 --- a/src/include/gnunet_rest_plugin.h +++ b/src/include/gnunet_rest_plugin.h @@ -1,27 +1,30 @@ /* 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 - 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 . - 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. + SPDX-License-Identifier: AGPL3.0-or-later */ /** * @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/ + * 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 */