From 7637fdf46bfa5a9f5e62e27a91b8ab789948d781 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Wed, 13 May 2015 18:13:02 -0400 Subject: [PATCH] Add javadoc documentation of plugin-lib interface MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérémie Galarneau --- include/babeltrace/plugin/plugin-lib.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/include/babeltrace/plugin/plugin-lib.h b/include/babeltrace/plugin/plugin-lib.h index 4a741bd2a..dc0cde03a 100644 --- a/include/babeltrace/plugin/plugin-lib.h +++ b/include/babeltrace/plugin/plugin-lib.h @@ -48,13 +48,26 @@ struct bt_notification; * The functions marked as mandatory MUST be exported by the shared object * to be considered a valid plug-in. */ + +/** + * Get the plug-in type implemented by the library. + * + * @returns One of #bt_plugin_type values + */ extern enum bt_plugin_type bt_plugin_lib_get_type(void); + +/** + * Get the name of the format implemented by the library. + * + * @returns A string (ownership is not transfered) + */ extern const char *bt_plugin_lib_get_format_name(void); /** * Create a plug-in instance configured with the provided parameters. * * @param params Map object of configuration parameters + * (see bt_object_map_create()) * @returns An instance of the plug-in */ extern struct bt_plugin *bt_plugin_lib_create(struct bt_object *params); -- 2.34.1