Updated documentation and fixed big memory leak

huggle · Sep 29, 2015 · b501c68 · b501c68
1 parent 34011ec
commit b501c68
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 19 deletions.
diff --git a/huggle/configuration.hpp b/huggle/configuration.hpp
@@ -166,7 +166,7 @@ namespace Huggle
              */
             static QString GetProjectURL(WikiSite *Project);
             static QString GetLocalizationDataPath();
-            //! Extension path (typically HR/extensions) where .py and .so files are in
+            //! Extension path (typically $huggle_home/extensions) where .py and .so files are in
             static QString GetExtensionsRootPath();
             //! Return a prefix for url
             static QString GetURLProtocolPrefix(WikiSite *s = nullptr);
@@ -231,7 +231,7 @@ namespace Huggle
             int             SystemConfig_ProviderCache = 200;
             //! Maximum size of ringlog
             int             SystemConfig_RingLogMaxSize = 2000;
-            //! Path where huggle contains its data
+            //! Path where huggle contains its data, known as $huggle_home in manual
             QString         HomePath;
             //! Path to a file where information about wikis are stored
             QString         WikiDB = "";
@@ -272,6 +272,7 @@ namespace Huggle
             //! Whether huggle check for an update on startup
             bool            SystemConfig_UpdatesEnabled = true;
             bool            SystemConfig_NotifyBeta = false;
+            //! If true huggle will perform a sanity check of its language files on startup
             bool            SystemConfig_LanguageSanity = false;
             bool            SystemConfig_RequestDelay = false;
             bool            SystemConfig_SuppressWarnings = true;
@@ -283,7 +284,8 @@ namespace Huggle
             //! mediawiki later, can be synced. If this cache is too low, some actions reported on HAN
             //! may be lost and never applied on actual edits, because these are parsed later
             int             SystemConfig_CacheHAN = 100;
-            //! Debug mode
+            //! Debug mode, if true huggle will switch to "display on terminal" mode, where all debug information
+            //! gets written only to terminal and not syslog widget
             bool            SystemConfig_Dot = false;
             bool            SystemConfig_InstantReverts = false;
             int             SystemConfig_RevertDelay = 6;
@@ -378,7 +380,7 @@ namespace Huggle
             QString     Platform;
         private:
             /*!
-             * \brief InsertConfig
+             * \brief InsertConfig stores a configuration KEY / VALUE in a configuration XML file
              * \param key Configuration key
              * \param value Value of key
              * \param s Stream writer

diff --git a/huggle/editbar.cpp b/huggle/editbar.cpp
@@ -156,6 +156,7 @@ void EditBar::ClearUser()
     {
         QLayoutItem *i = this->ui->horizontalLayout_user->itemAt(1);
         this->ui->horizontalLayout_user->removeItem(i);
+        delete i;
     }
 }
 
@@ -166,6 +167,7 @@ void EditBar::ClearPage()
     {
         QLayoutItem *i = this->ui->horizontalLayout_page->itemAt(1);
         this->ui->horizontalLayout_page->removeItem(i);
+        delete i;
     }
 }
 

diff --git a/huggle/editbar.hpp b/huggle/editbar.hpp
@@ -32,9 +32,8 @@ namespace Huggle
     class EditBarItem;
 
     /*!
-     * \brief The EditBar class can be used to list different edit information of pages like 
-     * the time and username of the last edit or do the same from the users perspective 
-     * (list the pages edited by a user)
+     * \brief The EditBar widget can be used to render various edit information of pages, like
+     *        the time and username of the last edit and display them as icons
      */
     class HUGGLE_EX EditBar : public QDockWidget
     {
@@ -46,21 +45,13 @@ namespace Huggle
 	     */
             explicit EditBar(QWidget *parent = 0);
             ~EditBar();
-	    /*!
-	     * \brief RemoveAll Removes all pages and users from the EditBar
-	     */
+            //! Removes all pages and user contributions in the EditBar
             void RemoveAll();
-	    /*!
-	     * \brief Refresh Reloads all pages and users from the EditBar
-	     */
+            //! Refresh page history and user information in the EditBar
             void Refresh();
-	    /*!
-	     * \brief RefreshPage Reloads all pages from the EditBar
-	     */
+            //! Reloads page history from the EditBar
             void RefreshPage();
-	    /*!
-	     * \brief RefreshUser Reloads all users from the EditBar
-	     */
+            //! Reloads all user contributions in the EditBar
             void RefreshUser();
         private slots:
             void on_pushButton_2_clicked();