[Xfce4-commits] [panel-plugins/xfce4-sensors-plugin] 01/01: More doxygen function comments

[noreply at xfce.org]

This is an automated email from the git hooks/post-receive script.

timystery pushed a commit to branch master
in repository panel-plugins/xfce4-sensors-plugin.

commit 25c19ec3e8365426db6810d09f7c27def47fc864
Author: Fabian <timystery at arcor.de>
Date:   Sat Mar 4 00:52:13 2017 +0100

    More doxygen function comments
---
 include/sensors-interface-plugin.h | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/include/sensors-interface-plugin.h b/include/sensors-interface-plugin.h
index 510fadb..4e0c6cd 100644
--- a/include/sensors-interface-plugin.h
+++ b/include/sensors-interface-plugin.h
@@ -193,9 +193,23 @@ typedef struct {
 }
 t_sensors;
 
+
 /* Regularly included functions in library */
-t_sensors * sensors_new (XfcePanelPlugin *plugin, gchar * plugin_config_file);
 
-void sensors_init_default_values (t_sensors *sensors, XfcePanelPlugin *plugin);
+/**
+ * Create new sensors plugin data object
+ * @param ptr_xfcepanelplugin: Pointer to panel plugin data
+ * @param ptr_plugin_config_filename
+ * @return pointer to newly allocated sensors object
+ */
+t_sensors * sensors_new (XfcePanelPlugin *ptr_xfcepanelplugin, gchar * ptr_plugin_config_filename);
+
+
+/**
+ * Initialize sensors structure with default values
+ * @param ptr_sensors: pointer to sensors plugin data
+ * @param ptr_xfcepanelplugin: Pointer to panel plugin data
+ */
+void sensors_init_default_values (t_sensors *ptr_sensors, XfcePanelPlugin *ptr_xfcepanelplugin);
 
 #endif /* XFCE4_SENSORS_INTERFACE_PLUGIN_H */

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.