doxygen image updates (and readme)

Author: Skycoder42

AutoUpdaterGui/updatecontroller.dox

@@ -7,61 +7,61 @@ Back to UpdaterController.
 
 ## Windows - Windows 10
 #### The Updater Elements
-@image html ./doc/images/win/dialog_ask.png "Ask Dialog"<br>
-@image html ./doc/images/win/dialog_progress.png "Progress Dialog"<br>
-@image html ./doc/images/win/dialog_no_updates.png "No Updates Dialog"<br>
-@image html ./doc/images/win/dialog_info.png "Detailed Update Information Dialog"<br>
-@image html ./doc/images/win/dialog_info_simple.png "Simple Update Information Dialog"<br>
-@image html ./doc/images/win/dialog_exit.png "Automatic Run - Exit Notification Dialog"<br>
+@image html ./doc/images/win_dialog_ask.png "Ask Dialog"<br>
+@image html ./doc/images/win_dialog_progress.png "Progress Dialog"<br>
+@image html ./doc/images/win_dialog_no_updates.png "No Updates Dialog"<br>
+@image html ./doc/images/win_dialog_info.png "Detailed Update Information Dialog"<br>
+@image html ./doc/images/win_dialog_info_simple.png "Simple Update Information Dialog"<br>
+@image html ./doc/images/win_dialog_exit.png "Automatic Run - Exit Notification Dialog"<br>
 
 #### The Update Panel
-@image html ./doc/images/win/panel_idle.png "Panel before clicking"<br>
-@image html ./doc/images/win/panel_checking.png "Panel while checking"<br>
-@image html ./doc/images/win/panel_updates.png "Panel with updates"<br>
-@image html ./doc/images/win/panel_no_updates.png "Panel without updates"<br>
+@image html ./doc/images/win_panel_idle.png "Panel before clicking"<br>
+@image html ./doc/images/win_panel_checking.png "Panel while checking"<br>
+@image html ./doc/images/win_panel_updates.png "Panel with updates"<br>
+@image html ./doc/images/win_panel_no_updates.png "Panel without updates"<br>
 
 #### The Action
-@image html ./doc/images/win/action.png "Update action inside a menu and a toolbar"<br>
+@image html ./doc/images/win_action.png "Update action inside a menu and a toolbar"<br>
 
 ## Mac - OsX 10.11
 The following pictures show the controller with a parent windows. Thus, all dialogs
 are shown as "sheets" to that window. If you create the UpdateController without a widget,
 they will show as normal toplevel windows instead.
 
 #### The Updater Elements
-@image html ./doc/images/mac/dialog_ask.png "Ask Dialog"<br>
-@image html ./doc/images/mac/dialog_progress.png "Progress Dialog"<br>
-@image html ./doc/images/mac/dialog_no_updates.png "No Updates Dialog"<br>
-@image html ./doc/images/mac/dialog_info.png "Detailed Update Information Dialog"<br>
-@image html ./doc/images/mac/dialog_info_simple.png "Simple Update Information Dialog"<br>
-@image html ./doc/images/mac/dialog_exit.png "Automatic Run - Exit Notification Dialog"<br>
+@image html ./doc/images/mac_dialog_ask.png "Ask Dialog"<br>
+@image html ./doc/images/mac_dialog_progress.png "Progress Dialog"<br>
+@image html ./doc/images/mac_dialog_no_updates.png "No Updates Dialog"<br>
+@image html ./doc/images/mac_dialog_info.png "Detailed Update Information Dialog"<br>
+@image html ./doc/images/mac_dialog_info_simple.png "Simple Update Information Dialog"<br>
+@image html ./doc/images/mac_dialog_exit.png "Automatic Run - Exit Notification Dialog"<br>
 
 #### The Update Panel
-@image html ./doc/images/mac/panel_idle.png "Panel before clicking"<br>
-@image html ./doc/images/mac/panel_checking.png "Panel while checking"<br>
-@image html ./doc/images/mac/panel_updates.png "Panel with updates"<br>
-@image html ./doc/images/mac/panel_no_updates.png "Panel without updates"<br>
+@image html ./doc/images/mac_panel_idle.png "Panel before clicking"<br>
+@image html ./doc/images/mac_panel_checking.png "Panel while checking"<br>
+@image html ./doc/images/mac_panel_updates.png "Panel with updates"<br>
+@image html ./doc/images/mac_panel_no_updates.png "Panel without updates"<br>
 
 #### The Action
-@image html ./doc/images/mac/action.png "Update action inside a menu and a toolbar"<br>
+@image html ./doc/images/mac_action.png "Update action inside a menu and a toolbar"<br>
 
 ## X11 - Ubuntu 14.04
 #### The Updater Elements
-@image html ./doc/images/x11/dialog_ask.png "Ask Dialog"<br>
-@image html ./doc/images/x11/dialog_progress.png "Progress Dialog"<br>
-@image html ./doc/images/x11/dialog_no_updates.png "No Updates Dialog"<br>
-@image html ./doc/images/x11/dialog_info.png "Detailed Update Information Dialog"<br>
-@image html ./doc/images/x11/dialog_info_simple.png "Simple Update Information Dialog"<br>
-@image html ./doc/images/x11/dialog_exit.png "Automatic Run - Exit Notification Dialog"<br>
+@image html ./doc/images/x11_dialog_ask.png "Ask Dialog"<br>
+@image html ./doc/images/x11_dialog_progress.png "Progress Dialog"<br>
+@image html ./doc/images/x11_dialog_no_updates.png "No Updates Dialog"<br>
+@image html ./doc/images/x11_dialog_info.png "Detailed Update Information Dialog"<br>
+@image html ./doc/images/x11_dialog_info_simple.png "Simple Update Information Dialog"<br>
+@image html ./doc/images/x11_dialog_exit.png "Automatic Run - Exit Notification Dialog"<br>
 
 #### The Update Panel
-@image html ./doc/images/x11/panel_idle.png "Panel before clicking"<br>
-@image html ./doc/images/x11/panel_checking.png "Panel while checking"<br>
-@image html ./doc/images/x11/panel_updates.png "Panel with updates"<br>
-@image html ./doc/images/x11/panel_no_updates.png "Panel without updates"<br>
+@image html ./doc/images/x11_panel_idle.png "Panel before clicking"<br>
+@image html ./doc/images/x11_panel_checking.png "Panel while checking"<br>
+@image html ./doc/images/x11_panel_updates.png "Panel with updates"<br>
+@image html ./doc/images/x11_panel_no_updates.png "Panel without updates"<br>
 
 #### The Action
-@image html ./doc/images/x11/action.png "Update action inside a menu and a toolbar"<br>
+@image html ./doc/images/x11_action.png "Update action inside a menu and a toolbar"<br>
 */
 
 /*!
@@ -334,7 +334,7 @@ UpdateController::maintenanceToolPath for more details.
 
 @overload
 @param maintenanceToolPath The path to the maintenancetool
-@param parentWidget The parent widget. Will serve as parent for the controller and windows
+@param parentWindow The parent widget. Will serve as parent for the controller and windows
 @param parent The parent object. Will serve as parent for the controller
 
 The maintenancetool path will be set to the given one (and cannot be changed). See

AutoUpdaterGui/updatecontroller.h

@@ -58,7 +58,7 @@ namespace QtAutoUpdater
 		//! Create a QAction to start this controller from
 		QAction *createUpdateAction(QObject *parent);
 		//! Creates a new "UpdatePanel" widget to place in your GUI
-		QWidget *createUpdatePanel(QWidget *parentWindow);
+		QWidget *createUpdatePanel(QWidget *parentWidget);
 
 		//! READ-Accessor for UpdateController::maintenanceToolPath
 		QString maintenanceToolPath() const;

README.md

@@ -32,12 +32,12 @@ Github repository: https://github.com/Skycoder42/QtAutoUpdater
 #### Screenshots
 Here some sample screenshots of the gui (The rocket of the information dialog is the "application icon" and depends on your application)
 
-| Dialog Sample      | Windows                                   | Mac                                       | X11                                       |
-|--------------------|-------------------------------------------|-------------------------------------------|-------------------------------------------|
-| Progress Dialog    | ![](./doc/images/win_dialog_progress.png) | ![](./doc/images/mac_dialog_progress.png) | ![](./doc/images/x11_dialog_progress.png) |
-| Information Dialog | ![](./doc/images/win_dialog_info.png)     | ![](./doc/images/mac_dialog_info.png)     | ![](./doc/images/x11_dialog_info.png)     |
-| Update Panel       | ![](./doc/images/win_panel_checking.png)  | ![](./doc/images/mac_panel_checking.png)  | ![](./doc/images/x11_panel_checking.png)  |
-| Update Action      | ![](./doc/images/win_action.png)          | ![](./doc/images/mac_action.png)          | ![](./doc/images/x11_action.png)          |
+| Windows                                                  | Mac                                                      | X11                                                      |
+|----------------------------------------------------------|----------------------------------------------------------|----------------------------------------------------------|
+| ![Progress Dialog](./doc/images/win_dialog_progress.png) | ![Progress Dialog](./doc/images/mac_dialog_progress.png) | ![Progress Dialog](./doc/images/x11_dialog_progress.png) |
+| ![Information Dialog](./doc/images/win_dialog_info.png)  | ![Information Dialog](./doc/images/mac_dialog_info.png)  | ![Information Dialog](./doc/images/x11_dialog_info.png)  |
+| ![Update Panel](./doc/images/win_panel_checking.png)     | ![Update Panel](./doc/images/mac_panel_checking.png)     | ![Update Panel](./doc/images/x11_panel_checking.png)     |
+| ![Update Action](./doc/images/win_action.png)            | ![Update Action](./doc/images/mac_action.png)            | ![Update Action](./doc/images/x11_action.png)            |
 
 ## Requirements
  - Qt Installer Framework: The updater requires the application to be installed using the framework and will use the frameworks update mechanism to check for updates (https://doc.qt.io/qtinstallerframework/, download at https://download.qt.io/official_releases/qt-installer-framework/)

doc/QtAutoUpdater.doxy

@@ -1,4 +1,4 @@
-# Doxyfile 1.8.10
+# Doxyfile 1.8.11
 
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
@@ -766,6 +766,12 @@ WARN_IF_DOC_ERROR      = YES
 
 WARN_NO_PARAMDOC       = YES
 
+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
+# a warning is encountered.
+# The default value is: NO.
+
+WARN_AS_ERROR          = NO
+
 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
 # can produce. The string should contain the $file, $line, and $text tags, which
 # will be replaced by the file and line number from which the warning originated
@@ -824,8 +830,8 @@ INPUT_ENCODING         = UTF-8
 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
-# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd,
-# *.vhdl, *.ucf, *.qsf, *.as and *.js.
+# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
+# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
 
 FILE_PATTERNS          = *.c \
                          *.cc \
@@ -940,7 +946,7 @@ EXAMPLE_RECURSIVE      = YES
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             = 
+IMAGE_PATH             = images
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -956,6 +962,10 @@ IMAGE_PATH             =
 # Note that the filter must not add or remove lines; it is applied before the
 # code is scanned, but not when the output code is generated. If lines are added
 # or removed, the anchors will not be placed correctly.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
 
 INPUT_FILTER           = 
 
@@ -965,6 +975,10 @@ INPUT_FILTER           =
 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
 # patterns match the file name, INPUT_FILTER is applied.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
 
 FILTER_PATTERNS        = 
 
@@ -1082,7 +1096,7 @@ VERBATIM_HEADERS       = YES
 # rich C++ code for which doxygen's built-in parser lacks the necessary type
 # information.
 # Note: The availability of this option depends on whether or not doxygen was
-# compiled with the --with-libclang option.
+# generated with the -Duse-libclang=ON option for CMake.
 # The default value is: NO.
 
 CLANG_ASSISTED_PARSING = NO
@@ -1826,6 +1840,14 @@ LATEX_SOURCE_CODE      = NO
 
 LATEX_BIB_STYLE        = plain
 
+# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
+# page will contain the date and time when the page was generated. Setting this
+# to NO can help when comparing the output of multiple runs.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_TIMESTAMP        = NO
+
 #---------------------------------------------------------------------------
 # Configuration options related to the RTF output
 #---------------------------------------------------------------------------