documentation of item properties dialog and SPAttributeTable

header stuff

(bzr r10831)

1 files changed, 29 insertions, 5 deletions

diff --git a/src/dialogs/item-properties.cpp b/src/dialogs/item-properties.cpp
index 16c29a69f..5fed0b84e 100644
--- a/src/dialogs/item-properties.cpp
+++ b/src/dialogs/item-properties.cpp
@@ -18,8 +18,6 @@
 #ifdef HAVE_CONFIG_H
 # include "config.h"
 #endif
-#include <gtk/gtk.h>
-#include <glibmm/i18n.h>
 
 #include "../desktop-handles.h"
 #include "../document.h"
@@ -44,6 +42,9 @@ static void sp_item_dialog_delete( GtkObject */*object*/, GdkEvent */*event*/, g
 static void sp_item_widget_modify_selection (SPWidget *spw, Inkscape::Selection *selection, guint flags, GtkWidget *itemw);
 static void sp_item_widget_change_selection (SPWidget *spw, Inkscape::Selection *selection, GtkWidget *itemw);
 
+/**
+ * \brief SPItemDialog callback for closing the dialog.
+ */
 static void sp_item_dialog_delete( GtkObject */*object*/, GdkEvent */*event*/, gpointer /*data*/ )
 {
     if (spid)
@@ -53,6 +54,9 @@ static void sp_item_dialog_delete( GtkObject */*object*/, GdkEvent */*event*/, g
     }
 }
 
+/**
+ * \brief SPItemDialog callback for a modification of the selected object (e.g. size, color, fill, etc.).
+ */
 static void sp_item_widget_modify_selection( SPWidget */*spw*/,
                                  Inkscape::Selection */*selection*/,
                                  guint /*flags*/,
@@ -64,6 +68,9 @@ static void sp_item_widget_modify_selection( SPWidget */*spw*/,
     }
 }
 
+/**
+ * \brief SPItemDialog callback for the selection of an other object.
+ */
 static void sp_item_widget_change_selection ( SPWidget */*spw*/,
                                   Inkscape::Selection */*selection*/,
                                   GtkWidget */*itemw*/ )
@@ -86,10 +93,9 @@ void sp_item_dialog(void)
 }
 
 /**
- * SPItemDialog class.
- * A widget for showing and editing the properties of an object.
+ * \brief Constructor.
  */
-SPItemDialog::SPItemDialog (void) :
+ SPItemDialog::SPItemDialog (void) :
     prefs_path("/dialogs/object/"),
     x(-1000),// impossible original value to make sure they are read from prefs
     y(-1000),// impossible original value to make sure they are read from prefs
@@ -165,6 +171,9 @@ SPItemDialog::SPItemDialog (void) :
     MakeWidget();
 }
 
+/**
+ * \brief Destructor.
+ */
 SPItemDialog::~SPItemDialog (void)
 {
     if (closing)
@@ -196,6 +205,9 @@ SPItemDialog::~SPItemDialog (void)
     }
 }
 
+/**
+ * \brief Constructor auxiliary function creating the child widgets.
+ */
 void SPItemDialog::MakeWidget(void)
 {
 	// if (gtk_widget_get_visible (GTK_WIDGET(spw))) {
@@ -309,6 +321,9 @@ void SPItemDialog::MakeWidget(void)
     widget_setup();
 }
 
+/**
+ * \brief Updates entries and other child widgets on selection change, object modification, etc.
+ */
 void SPItemDialog::widget_setup(void)
 {
     if (blocked)
@@ -399,6 +414,9 @@ void SPItemDialog::widget_setup(void)
     blocked = false;
 }
 
+/**
+ * \brief Sets object properties (ID, label, title, description) on user input.
+ */
 void SPItemDialog::label_changed(void)
 {
     if (blocked)
@@ -459,6 +477,9 @@ void SPItemDialog::label_changed(void)
     blocked = false;
 }
 
+/**
+ * \brief Callback for checkbox Lock.
+ */
 void SPItemDialog::sensitivity_toggled (void)
 {
     if (blocked)
@@ -476,6 +497,9 @@ void SPItemDialog::sensitivity_toggled (void)
     blocked = false;
 }
 
+/**
+ * \brief Callback for checkbox Hide.
+ */
 void SPItemDialog::hidden_toggled(void)
 {
     if (blocked)