Merge lp:~inkscape+alexander/inkscape/comments into lp:~inkscape.dev/inkscape/trunk

[jazzynico]

[jazzynico (jazzynico)]

Conflicts fixed and comments merged rev. 14986.
Thanks Alexander!

review: Approve

=== modified file 'src/document.cpp'
--- src/document.cpp	2016-06-08 09:16:29 +0000
+++ src/document.cpp	2016-06-13 05:33:40 +0000
@@ -1591,6 +1591,23 @@
 
 /* Helpers */
 
+<<<<<<< TREE
+=======
+gboolean
+sp_document_resource_list_free(gpointer /*key*/, gpointer value, gpointer /*data*/)
+{
+    g_slist_free((GSList *) value);
+    return TRUE;
+}
+
+/**
+ * Count the siblings of an object (plus the object itself).
+ *
+ * @param [in] obj Pointer to the object which siblings shall be counted.
+ * @param [inout] Number of objects counted so far (in previous iterations / recursion levels)
+ * @return Number of siblings (plus the object itself)
+ */
+>>>>>>> MERGE-SOURCE
 static unsigned int count_objects_recursive(SPObject *obj, unsigned int count)
 {
     count++; // obj itself
@@ -1602,11 +1619,22 @@
     return count;
 }
 
+/**
+ * Count the number of objects in a given document recursively using the count_objects_recursive helper function
+ * 
+ * @param[in] document Pointer to the document for counting objects
+ * @return Numer of objects in the document
+ */
 static unsigned int objects_in_document(SPDocument *document)
 {
     return count_objects_recursive(document->getRoot(), 0);
 }
 
+/**
+ * Remove unused definitions etc. recursively from an object and its siblings
+ *
+ * @param[inout] obj Object which shall be "cleaned"
+ */
 static void vacuum_document_recursive(SPObject *obj)
 {
     if (SP_IS_DEFS(obj)) {
@@ -1621,10 +1649,20 @@
     }
 }
 
+/**
+ * Remove unused definitions etc. recursively from an entire document.
+ *
+ * @return Number of removed objects
+ */
 unsigned int SPDocument::vacuumDocument()
 {
+<<<<<<< TREE
     unsigned int start = objects_in_document(this);
     unsigned int end;
+=======
+    unsigned int const start = objects_in_document(this);
+    unsigned int end = start;
+>>>>>>> MERGE-SOURCE
     unsigned int newend = start;
 
     unsigned int iterations = 0;
@@ -1639,6 +1677,7 @@
         newend = objects_in_document(this);
 
     } while (iterations < 100 && newend < end);
+	// We stop if vacuum_document_recursive doesn't remove any more objects or after 100 iterations, whichever occurs first.
 
     return start - newend;
 }
@@ -1647,7 +1686,12 @@
     return priv->seeking;
 }
 
-void SPDocument::setModifiedSinceSave(bool modified) {
+/**
+ * Indicate to the user if the document has been modified since the last save by displaying a "*" in front of the name of the file in the window title.
+ *
+ * @param[in] modified True if the document has been modified.
+ */
+void SPDocument::setModifiedSinceSave(bool const modified) {
     this->modified_since_save = modified;
     if (SP_ACTIVE_DESKTOP) {
         Gtk::Window *parent = SP_ACTIVE_DESKTOP->getToplevel();
 
=== modified file 'src/document.h'
--- src/document.h	2016-06-01 19:13:32 +0000
+++ src/document.h	2016-06-13 05:33:40 +0000
@@ -198,7 +198,7 @@
     bool isSeeking() const;
 
     bool isModifiedSinceSave() const { return modified_since_save; }
-    void setModifiedSinceSave(bool modified = true);
+    void setModifiedSinceSave(bool const modified = true);
 
 private:
     SPDocument(SPDocument const &); // no copy
 
=== modified file 'src/sp-object.cpp'
--- src/sp-object.cpp	2016-03-18 17:58:10 +0000
+++ src/sp-object.cpp	2016-06-13 05:33:40 +0000
@@ -71,13 +71,17 @@
     SPObject::repr_order_changed
 };
 
-// A friend class used to set internal members on SPObject so as to not expose settors in SPObject's public API
+/**
+ * A friend class used to set internal members on SPObject so as to not expose settors in SPObject's public API
+ */
 class SPObjectImpl
 {
 public:
 
 /**
  * Null's the id member of an SPObject without attempting to free prior contents.
+ *
+ * @param[inout] obj Pointer to the object which's id shall be nulled.
  */
     static void setIdNull( SPObject* obj ) {
         if (obj) {
@@ -87,6 +91,9 @@
 
 /**
  * Sets the id member of an object, freeing any prior content.
+ *
+ * @param[inout] obj Pointer to the object which's id shall be set.
+ * @param[in] id New id
  */
     static void setId( SPObject* obj, gchar const* id ) {
         if (obj && (id != obj->id) ) {
@@ -104,6 +111,9 @@
 static gchar *sp_object_get_unique_id(SPObject    *object,
                                       gchar const *defid);
 
+/**
+ * Constructor, sets all attributes to default values.
+ */
 SPObject::SPObject()
     : cloned(0), uflags(0), mflags(0), hrefcount(0), _total_hrefcount(0),
       document(NULL), parent(NULL), children(NULL), _last_child(NULL),
@@ -126,6 +136,9 @@
     this->context_style = NULL;
 }
 
+/**
+ * Destructor, frees the used memory and unreferences a potential successor of the object.
+ */
 SPObject::~SPObject() {
     g_free(this->_label);
     g_free(this->_default_label);