[Xfce4-commits] [panel-plugins/xfce4-sensors-plugin] 01/01: Doxygen comment enhancements

[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 4f583eef88822e7bd28d60f3daf84f2f246d1622
Author: Fabian <timystery at arcor.de>
Date:   Tue Apr 18 21:49:07 2017 +0200

    Doxygen comment enhancements
---
 include/configuration.h |  2 +-
 src/callbacks.c         | 22 ++++++++++++++++++++--
 2 files changed, 21 insertions(+), 3 deletions(-)

diff --git a/include/configuration.h b/include/configuration.h
index 53fadc4..3a5414a 100644
--- a/include/configuration.h
+++ b/include/configuration.h
@@ -44,7 +44,7 @@ gint get_Id_from_address (gint chipnumber, gint addr_chipfeature,
  * @param ptr_panelplugin: pointer to panel plugin structure
  * @param ptr_sensors: pointer to sensors structure
  */
-void sensors_write_config (XfcePanelPlugin *plugin,t_sensors *ptr_sensors);
+void sensors_write_config (XfcePanelPlugin *ptr_panelplugin,t_sensors *ptr_sensors);
 
 
 /**
diff --git a/src/callbacks.c b/src/callbacks.c
index 87402fc..3d6f892 100644
--- a/src/callbacks.c
+++ b/src/callbacks.c
@@ -40,13 +40,22 @@
 /* Forward declarations */
 gint set_value_in_treemodel_and_return_index_and_feature(t_sensors_dialog *ptr_sensorsdialog, gchar *ptr_str_cellpath, gint col_treeview, GValue *ptr_value, t_chipfeature **ptr_ptr_chipfeature);
 
-enum
+/**
+ * Enumeration of the colums for the used GtkTreeModel.
+ */
+enum Enum_TreeColumn
 {
+    /// User chosen name of the chipfeature
     eTreeColumn_Name = 0,
+    /// non-writable value of the chipfeature
     eTreeColumn_Value = 1,
+    /// whether to show the chipfeature in the display or panel
     eTreeColumn_Show = 2,
+    /// color to use for the font or bar
     eTreeColumn_Color = 3,
+    /// expected minimum value, used also for calculating 0 percent
     eTreeColumn_Min = 4,
+    /// expected maximum value, used also for calculating 100 percent
     eTreeColumn_Max = 5
 };
 
@@ -95,7 +104,16 @@ sensor_entry_changed_ (GtkWidget *ptr_comboboxwidget, t_sensors_dialog *ptr_sens
     TRACE ("leaves sensor_entry_changed");
 }
 
-
+/**
+ * Sets the value in the determined column for the given path to a cell in the
+ *  GtkTree.
+ * @param ptr_sensorsdialog: pointer to sensors dialog structure
+ * @param ptr_str_cellpath: Path in GtkTree
+ * @param col_treeview: column in treeview
+ * @param ptr_value: pointer to value to store
+ * @param ptr_ptr_chipfeature: out pointer of determined chipfeature
+ * @return index of chipfeature for ptr_str_cellpath
+ */
 gint set_value_in_treemodel_and_return_index_and_feature(t_sensors_dialog *ptr_sensorsdialog, gchar *ptr_str_cellpath, gint col_treeview, GValue *ptr_value, t_chipfeature **ptr_ptr_chipfeature)
 {
     gint idx_active_combobox = -1;

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