From b529579e47e1f956351712965c057f16075f6463 Mon Sep 17 00:00:00 2001 From: Skycoder42 Date: Sun, 12 Mar 2017 21:30:22 +0100 Subject: [PATCH] wip doc fix --- README.md | 98 +++++++------- doc/Doxyfile | 278 ++++++++++++++++++++------------------- doc/gh_header.html | 2 +- doc/makedoc.sh | 2 +- doc/updatecontroller.dox | 28 ++-- 5 files changed, 209 insertions(+), 199 deletions(-) mode change 100644 => 100755 doc/makedoc.sh diff --git a/README.md b/README.md index cffbe36f..3a9a8c67 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # QtAutoUpdater -[![BSD3 License](https://img.shields.io/badge/license-BSD3-blue.svg?style=flat)](https://opensource.org/licenses/BSD-3-Clause) - The Qt auto updater library is a library to automatically check for updates and install them. This repository includes: - A library with the basic updater (without any GUI) - A second library that requires the first one and adds basic GUI features -Github repository: https://github.com/Skycoder42/QtAutoUpdater - -## Main Features +## Features ### Core Library - Automatic Check for updates using the maintenancetool - Can automatically run the maintenancetool after the application finished @@ -30,19 +26,19 @@ Here some sample screenshots of the gui (The rocket of the information dialog is | Dialog Sample | Windows | Mac | X11 | |--------------------|----------------------------------------------------------|----------------------------------------------------------|----------------------------------------------------------| -| Progress Dialog | ![Progress Dialog](./doc/images/win_dialog_progress.png) | ![Progress Dialog](./doc/images/mac_dialog_progress.png) | ![Progress Dialog](./doc/images/x11_dialog_progress.png) | +| Progress Dialog | ![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 | ![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 Button | ![Update Button](./doc/images/win_button_checking.png) | ![Update Button](./doc/images/mac_button_checking.png) | ![Update Button](./doc/images/x11_button_checking.png) | -| Update Action | ![Update Action](./doc/images/win_action.png) | ![Update Action](./doc/images/mac_action.png) | ![Update Action](./doc/images/x11_action.png) | +| Update Button | ![Update Button](./doc/images/win_button_checking.png) | ![Update Button](./doc/images/mac_button_checking.png) | ![Update Button](./doc/images/x11_button_checking.png) | +| Update Action | ![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/) - - C++11 - The library makes heavy use of it's features - - Qt 5.6 (Since I'm using new features of 5.6, older Versions won't work without modification) - - If you are using Qt 5.5, you can download version 1.0.0. It's the only one that supports it + - 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 via Qt MaintenanceTool) - Since the Installer Framework supports Windows, Mac and X11 only, it's the same for this library -## Getting started +## Usage +The autoupdater is provided as a Qt module. Thus, all you have to do is add the module, and then, in your project, add `QT += autoupdatercore` or `QT += autoupdatergui` to your .pro file - depending on what you need! + +### Getting started The usage of this library is not that complicated. However, to make this work you will have to use the Qt Installer Framework to create and installer/updater. If you already now how to to that, just check out the examples below. If not, here are some links that will explain how to create an online-installer using the framework. Once you have figured out how to do that, it's only a small step to the updater library: @@ -67,24 +63,24 @@ The following example shows the basic usage of the updater. Only the core librar int main(int argc, char *argv[]) { - QCoreApplication a(argc, argv); - //create the updater with the application as parent -> will live long enough start the tool on exit - QtAutoUpdater::Updater *updater = new QtAutoUpdater::Updater("C:/Qt/MaintenanceTool", &a);//.exe is automatically added - - QObject::connect(updater, &QtAutoUpdater::Updater::checkUpdatesDone, [updater](bool hasUpdate, bool hasError) { - qDebug() << "Has updates:" << hasUpdate << "\nHas errors:" << hasError; - if(hasUpdate) { - //As soon as the application quits, the maintenancetool will be started in update mode - updater->runUpdaterOnExit(); - qDebug() << "Update info:" << updater->updateInfo(); - } - //Quit the application - qApp->quit(); - }); - - //start the update check - updater->checkForUpdates(); - return a.exec(); + QCoreApplication a(argc, argv); + //create the updater with the application as parent -> will live long enough start the tool on exit + QtAutoUpdater::Updater *updater = new QtAutoUpdater::Updater("C:/Qt/MaintenanceTool", &a);//.exe is automatically added + + QObject::connect(updater, &QtAutoUpdater::Updater::checkUpdatesDone, [updater](bool hasUpdate, bool hasError) { + qDebug() << "Has updates:" << hasUpdate << "\nHas errors:" << hasError; + if(hasUpdate) { + //As soon as the application quits, the maintenancetool will be started in update mode + updater->runUpdaterOnExit(); + qDebug() << "Update info:" << updater->updateInfo(); + } + //Quit the application + qApp->quit(); + }); + + //start the update check + updater->checkForUpdates(); + return a.exec(); } ``` @@ -97,23 +93,23 @@ This example will show you the full dialog flow of the controller. Both librarie int main(int argc, char *argv[]) { - QApplication a(argc, argv); - //Since there is no mainwindow, the various dialogs should not quit the app - QApplication::setQuitOnLastWindowClosed(false); - //create the update controller with the application as parent -> will live long enough start the tool on exit - //since there is no parent window, all dialogs will be top-level windows - QtAutoUpdater::UpdateController *controller = new QtAutoUpdater::UpdateController("C:/Qt/MaintenanceTool", &a);//.exe is automatically added - - QObject::connect(updater, &QtAutoUpdater::UpdateController::runningChanged, [updater](bool running) { - qDebug() << "Running changed:" << running; - //quit the application as soon as the updating finished - if(!running) - qApp->quit(); - }); - - //start the update check -> AskLevel to give the user maximum control - controller->start(QtAutoUpdater::UpdateController::AskLevel); - return a.exec(); + QApplication a(argc, argv); + //Since there is no mainwindow, the various dialogs should not quit the app + QApplication::setQuitOnLastWindowClosed(false); + //create the update controller with the application as parent -> will live long enough start the tool on exit + //since there is no parent window, all dialogs will be top-level windows + QtAutoUpdater::UpdateController *controller = new QtAutoUpdater::UpdateController("C:/Qt/MaintenanceTool", &a);//.exe is automatically added + + QObject::connect(updater, &QtAutoUpdater::UpdateController::runningChanged, [updater](bool running) { + qDebug() << "Running changed:" << running; + //quit the application as soon as the updating finished + if(!running) + qApp->quit(); + }); + + //start the update check -> AskLevel to give the user maximum control + controller->start(QtAutoUpdater::UpdateController::AskLevel); + return a.exec(); } ``` @@ -134,15 +130,15 @@ Downloads are available via [github releases](https://github.com/Skycoder42/QtAu - msvc2015 x64 - mingw 4.9.2 - OsX - - clang x64 + - clang x64 - X11 (Linux) - - gcc x64 + - gcc x64 - The (public) header files needed for these binaries - The HTML and QtHelp documentation - The german translations and the translation template file **Note:**
-The downloads are "libraries", not dll/so/dylib files. If you want to use them as dynamic library, you will have to modify the code and build them yourself. +The downloads are "libraries", not dll/so/dylib files. If you want to use them as dynamic library, you will have to modify the code and build them yourself. ## Building it yourself If you want to build the QtAutoUpdater yourself, make shure that you fullfill all the requirements listed above. To build it, the only other dependencies beside Qt itself is the [DialogMaster](https://github.com/Skycoder42/DialogMaster), which is referenced as submodule. Just make shure to clone the repository recursivly. But please note that the project only supports Desktop Windows, OsX and X11. Trying to build it for other configurations will propably fail! diff --git a/doc/Doxyfile b/doc/Doxyfile index e1f1e88b..58ee907e 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -51,14 +51,14 @@ PROJECT_BRIEF = "A Qt library to automatically check for updates and in # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = +PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = +OUTPUT_DIRECTORY = # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and @@ -119,16 +119,16 @@ REPEAT_BRIEF = YES # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief @@ -162,7 +162,7 @@ FULL_PATH_NAMES = NO # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. -STRIP_FROM_PATH = +STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which @@ -171,7 +171,7 @@ STRIP_FROM_PATH = # specify the list of include paths that are normally passed to the compiler # using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't @@ -239,31 +239,31 @@ TAB_SIZE = 4 # newlines. ALIASES = "accessors{1}=\1
Accessors
" \ - readAc{1}=READ\1 \ - writeAc{1}=WRITE\1 \ - notifyAc{1}=NOTIFY\1 \ - memberAc{1}=MEMBER\1 \ - resetAc{1}=RESET\1 \ - revisionAc{1}=REVISION\1 \ - designableAc{1}=DESIGNABLE\1 \ - scriptableAc{1}=SCRIPTABLE\1 \ - storedAc{1}=STORED\1 \ - userAc{1}=USER\1 \ - "constantAc=CONSTANT" \ - "finalAc=FINAL" \ - "default{1}=Default: \1
" \ - "readAcFn{1}=READ accessor for \1" \ - "writeAcFn{1}=WRITE accessor for \1" \ - "notifyAcFn{1}=NOTIFY accessor for \1" \ - "resetAcFn{1}=RESET accessor for \1" \ - "memberAcFn{1}=MEMBER accessor for \1" \ - "inherit{1}=Inherits \1" + readAc{1}=READ\1 \ + writeAc{1}=WRITE\1 \ + notifyAc{1}=NOTIFY\1 \ + memberAc{1}=MEMBER\1 \ + resetAc{1}=RESET\1 \ + revisionAc{1}=REVISION\1 \ + designableAc{1}=DESIGNABLE\1 \ + scriptableAc{1}=SCRIPTABLE\1 \ + storedAc{1}=STORED\1 \ + userAc{1}=USER\1 \ + "constantAc=CONSTANT" \ + "finalAc=FINAL" \ + "default{1}=Default: \1
" \ + "readAcFn{1}=READ accessor for \1" \ + "writeAcFn{1}=WRITE accessor for \1" \ + "notifyAcFn{1}=NOTIFY accessor for \1" \ + "resetAcFn{1}=RESET accessor for \1" \ + "memberAcFn{1}=MEMBER accessor for \1" \ + "inherit{1}=Inherits \1" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. -TCL_SUBST = +TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For @@ -310,7 +310,7 @@ OPTIMIZE_OUTPUT_VHDL = NO # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. -EXTENSION_MAPPING = +EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable @@ -667,7 +667,7 @@ GENERATE_DEPRECATEDLIST= YES # sections, marked by \if ... \endif and \cond # ... \endcond blocks. -ENABLED_SECTIONS = +ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the @@ -709,7 +709,7 @@ SHOW_NAMESPACES = YES # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. -FILE_VERSION_FILTER = +FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated @@ -722,7 +722,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = +LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -732,7 +732,7 @@ LAYOUT_FILE = # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. -CITE_BIB_FILES = +CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages @@ -797,7 +797,7 @@ WARN_FORMAT = "$file:$line: $text" # messages should be written. If left blank the output is written to standard # error (stderr). -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files @@ -810,7 +810,7 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = ../src \ - . + . # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -836,48 +836,48 @@ INPUT_ENCODING = UTF-8 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. FILE_PATTERNS = *.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 \ - *.js \ - *.qdoc + *.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 \ + *.js \ + *.qdoc # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -909,10 +909,10 @@ EXCLUDE_SYMLINKS = NO # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = moc_* \ - ui_* \ - qrc_* \ - tst_* \ - *_p.* + ui_* \ + qrc_* \ + tst_* \ + *_p.* # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the @@ -923,14 +923,28 @@ EXCLUDE_PATTERNS = moc_* \ # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* -EXCLUDE_SYMBOLS = + +EXCLUDE_SYMBOLS = QAbstractAspect \ + QBasicAtomicInteger \ + QBasicAtomicPointer \ + QComponent \ + QEntity \ + QFutureWatcherBase \ + QGeometry \ + QGeometryRenderer \ + QMaterial \ + QNode \ + QNodeCreatedChangeBase \ + QPaintEngineEx \ + QQmlExtensionInterface \ + QTechniqueFilter # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = ../examples \ - ./snippets + ./snippets # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and @@ -971,7 +985,7 @@ IMAGE_PATH = ./images # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. -INPUT_FILTER = +INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the @@ -984,7 +998,7 @@ INPUT_FILTER = # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. -FILTER_PATTERNS = +FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for @@ -999,14 +1013,14 @@ FILTER_SOURCE_FILES = NO # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. -FILTER_SOURCE_PATTERNS = +FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -1118,7 +1132,7 @@ COLS_IN_ALPHA_INDEX = 5 # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output @@ -1172,7 +1186,7 @@ HTML_HEADER = gh_header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = +HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1184,7 +1198,7 @@ HTML_FOOTER = # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_STYLESHEET = +HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets @@ -1197,7 +1211,7 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1344,7 +1358,7 @@ CHM_FILE = ./HSCompanionAdminToolHelp.chm # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. -HHC_LOCATION = +HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). @@ -1357,7 +1371,7 @@ GENERATE_CHI = NO # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. -CHM_INDEX_ENCODING = +CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it @@ -1428,14 +1442,14 @@ QHP_CUST_FILTER_ATTRS = "qtautoupdater 2.1.0" # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. -QHP_SECT_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. -QHG_LOCATION = +QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To @@ -1568,7 +1582,7 @@ MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_EXTENSIONS = +MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site @@ -1576,7 +1590,7 @@ MATHJAX_EXTENSIONS = # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_CODEFILE = +MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and @@ -1636,7 +1650,7 @@ EXTERNAL_SEARCH = NO # Searching" for details. # This tag requires that the tag SEARCHENGINE is set to YES. -SEARCHENGINE_URL = +SEARCHENGINE_URL = # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed # search data is written to a file for indexing by an external tool. With the @@ -1652,7 +1666,7 @@ SEARCHDATA_FILE = searchdata.xml # projects and redirect the results back to the right project. # This tag requires that the tag SEARCHENGINE is set to YES. -EXTERNAL_SEARCH_ID = +EXTERNAL_SEARCH_ID = # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen # projects other than the one defined by this configuration file, but that are @@ -1662,7 +1676,7 @@ EXTERNAL_SEARCH_ID = # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... # This tag requires that the tag SEARCHENGINE is set to YES. -EXTRA_SEARCH_MAPPINGS = +EXTRA_SEARCH_MAPPINGS = #--------------------------------------------------------------------------- # Configuration options related to the LaTeX output @@ -1726,7 +1740,7 @@ PAPER_TYPE = a4 # If left blank no extra packages will be included. # This tag requires that the tag GENERATE_LATEX is set to YES. -EXTRA_PACKAGES = +EXTRA_PACKAGES = # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the # generated LaTeX document. The header should contain everything until the first @@ -1742,7 +1756,7 @@ EXTRA_PACKAGES = # to HTML_HEADER. # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_HEADER = +LATEX_HEADER = # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the # generated LaTeX document. The footer should contain everything after the last @@ -1753,7 +1767,7 @@ LATEX_HEADER = # Note: Only use a user-defined footer if you know what you are doing! # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_FOOTER = +LATEX_FOOTER = # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined # LaTeX style sheets that are included after the standard style sheets created @@ -1764,7 +1778,7 @@ LATEX_FOOTER = # list). # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_EXTRA_STYLESHEET = +LATEX_EXTRA_STYLESHEET = # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the LATEX_OUTPUT output @@ -1772,7 +1786,7 @@ LATEX_EXTRA_STYLESHEET = # markers available. # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_EXTRA_FILES = +LATEX_EXTRA_FILES = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will @@ -1880,14 +1894,14 @@ RTF_HYPERLINKS = NO # default style sheet that doxygen normally uses. # This tag requires that the tag GENERATE_RTF is set to YES. -RTF_STYLESHEET_FILE = +RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an RTF document. Syntax is # similar to doxygen's config file. A template extensions file can be generated # using doxygen -e rtf extensionFile. # This tag requires that the tag GENERATE_RTF is set to YES. -RTF_EXTENSIONS_FILE = +RTF_EXTENSIONS_FILE = # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code # with syntax highlighting in the RTF output. @@ -1932,7 +1946,7 @@ MAN_EXTENSION = .3 # MAN_EXTENSION with the initial . removed. # This tag requires that the tag GENERATE_MAN is set to YES. -MAN_SUBDIR = +MAN_SUBDIR = # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it # will generate one additional man file for each entity documented in the real @@ -2045,7 +2059,7 @@ PERLMOD_PRETTY = YES # overwrite each other's variables. # This tag requires that the tag GENERATE_PERLMOD is set to YES. -PERLMOD_MAKEVAR_PREFIX = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor @@ -2086,7 +2100,7 @@ SEARCH_INCLUDES = YES # preprocessor. # This tag requires that the tag SEARCH_INCLUDES is set to YES. -INCLUDE_PATH = +INCLUDE_PATH = # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the @@ -2095,8 +2109,8 @@ INCLUDE_PATH = # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. INCLUDE_FILE_PATTERNS = *.h \ - *.hpp \ - *.qdoc + *.hpp \ + *.qdoc # The PREDEFINED tag can be used to specify one or more macro names that are # defined before the preprocessor is started (similar to the -D option of e.g. @@ -2106,7 +2120,7 @@ INCLUDE_FILE_PATTERNS = *.h \ # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = +PREDEFINED = # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The @@ -2115,7 +2129,7 @@ PREDEFINED = # definition found in the source code. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will # remove all references to function-like macros that are alone on a line, have @@ -2144,13 +2158,13 @@ SKIP_FUNCTION_MACROS = YES # the path). If a tag file is not located in the directory in which doxygen is # run, you must also specify the path to the tagfile here. -TAGFILES = +TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create a # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. -GENERATE_TAGFILE = +GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES, all external class will be listed in # the class index. If set to NO, only the inherited external classes will be @@ -2199,14 +2213,14 @@ CLASS_DIAGRAMS = YES # the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. -MSCGEN_PATH = +MSCGEN_PATH = # You can include diagrams made with dia in doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The # DIA_PATH tag allows you to specify the directory where the dia binary resides. # If left empty dia is assumed to be found in the default search path. -DIA_PATH = +DIA_PATH = # If set to YES the inheritance and collaboration graphs will hide inheritance # and usage relations if the target is undocumented or is not a class. @@ -2255,7 +2269,7 @@ DOT_FONTSIZE = 10 # the path where dot can find it using this tag. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTPATH = +DOT_FONTPATH = # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for # each documented class showing the direct and indirect inheritance relations. @@ -2399,26 +2413,26 @@ INTERACTIVE_SVG = NO # found. If left blank, it is assumed the dot tool can be found in the path. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_PATH = +DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the \dotfile # command). # This tag requires that the tag HAVE_DOT is set to YES. -DOTFILE_DIRS = +DOTFILE_DIRS = # The MSCFILE_DIRS tag can be used to specify one or more directories that # contain msc files that are included in the documentation (see the \mscfile # command). -MSCFILE_DIRS = +MSCFILE_DIRS = # The DIAFILE_DIRS tag can be used to specify one or more directories that # contain dia files that are included in the documentation (see the \diafile # command). -DIAFILE_DIRS = +DIAFILE_DIRS = # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the # path where java can find the plantuml.jar file. If left blank, it is assumed @@ -2426,17 +2440,17 @@ DIAFILE_DIRS = # generate a warning when it encounters a \startuml command in this case and # will not generate output for the diagram. -PLANTUML_JAR_PATH = +PLANTUML_JAR_PATH = # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a # configuration file for plantuml. -PLANTUML_CFG_FILE = +PLANTUML_CFG_FILE = # When using plantuml, the specified paths are searched for files specified by # the !include statement in a plantuml block. -PLANTUML_INCLUDE_PATH = +PLANTUML_INCLUDE_PATH = # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes # that will be shown in the graph. If the number of nodes in a graph becomes diff --git a/doc/gh_header.html b/doc/gh_header.html index 5ffb77e7..37d1c431 100644 --- a/doc/gh_header.html +++ b/doc/gh_header.html @@ -51,7 +51,7 @@ - + diff --git a/doc/makedoc.sh b/doc/makedoc.sh old mode 100644 new mode 100755 index 0cfaa7c1..ab73ca0f --- a/doc/makedoc.sh +++ b/doc/makedoc.sh @@ -40,7 +40,7 @@ if [ "$DOXY_STYLE_EXTRA" ]; then fi for tagFile in $(find "$qtDocs" -name *.tags); do - if [ $(basename "$tagFile") != "qtautoupdater/.tags" ]; then + if [ $(basename "$tagFile") != "qtautoupdater.tags" ]; then echo "TAGFILES += "$tagFile=https://doc.qt.io/qt-5"" >> Doxyfile fi done diff --git a/doc/updatecontroller.dox b/doc/updatecontroller.dox index ec9aa642..9f8d3e40 100644 --- a/doc/updatecontroller.dox +++ b/doc/updatecontroller.dox @@ -2,11 +2,11 @@ @page image_page Image Page @brief Shows sample images for the updater for all the supported platforms +@tableofcontents -Back to QtAutoUpdater::UpdateController. - -## Windows - Windows 10 -#### The Updater Elements +# Images {#autoupdater_controller_images} +## Windows - Windows 10 {#autoupdater_controller_images_win} +### The Updater Elements {#autoupdater_controller_images_win_1} @image html win_dialog_ask.png "Ask Dialog"
@image html win_dialog_progress.png "Progress Dialog"
@image html win_dialog_no_updates.png "No Updates Dialog"
@@ -14,21 +14,21 @@ Back to QtAutoUpdater::UpdateController. @image html win_dialog_info_simple.png "Simple Update Information Dialog"
@image html win_dialog_exit.png "Automatic Run - Exit Notification Dialog"
-#### The Update Button +### The Update Button {#autoupdater_controller_images_win_2} @image html win_button_idle.png "Button before clicking"
@image html win_button_checking.png "Button while checking"
@image html win_button_updates.png "Button with updates"
@image html win_button_no_updates.png "Button without updates"
-#### The Action +### The Action {#autoupdater_controller_images_win_3} @image html win_action.png "Update action inside a menu and a toolbar"
-## Mac - OsX 10.11 +## Mac - OsX 10.11 {#autoupdater_controller_images_osx} 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 +### The Updater Elements {#autoupdater_controller_images_osx_1} @image html mac_dialog_ask.png "Ask Dialog"
@image html mac_dialog_progress.png "Progress Dialog"
@image html mac_dialog_no_updates.png "No Updates Dialog"
@@ -36,17 +36,17 @@ they will show as normal toplevel windows instead. @image html mac_dialog_info_simple.png "Simple Update Information Dialog"
@image html mac_dialog_exit.png "Automatic Run - Exit Notification Dialog"
-#### The Update Button +### The Update Button {#autoupdater_controller_images_osx_2} @image html mac_button_idle.png "Button before clicking"
@image html mac_button_checking.png "Button while checking"
@image html mac_button_updates.png "Button with updates"
@image html mac_button_no_updates.png "Button without updates"
-#### The Action +### The Action {#autoupdater_controller_images_osx_3} @image html mac_action.png "Update action inside a menu and a toolbar"
-## X11 - Ubuntu 14.04 -#### The Updater Elements +## X11 - Ubuntu 14.04 {#autoupdater_controller_images_x11} +### The Updater Elements {#autoupdater_controller_images_x11_1} @image html x11_dialog_ask.png "Ask Dialog"
@image html x11_dialog_progress.png "Progress Dialog"
@image html x11_dialog_no_updates.png "No Updates Dialog"
@@ -54,13 +54,13 @@ they will show as normal toplevel windows instead. @image html x11_dialog_info_simple.png "Simple Update Information Dialog"
@image html x11_dialog_exit.png "Automatic Run - Exit Notification Dialog"
-#### The Update Button +### The Update Button {#autoupdater_controller_images_x11_2} @image html x11_button_idle.png "Button before clicking"
@image html x11_button_checking.png "Button while checking"
@image html x11_button_updates.png "Button with updates"
@image html x11_button_no_updates.png "Button without updates"
-#### The Action +### The Action {#autoupdater_controller_images_x11_3} @image html x11_action.png "Update action inside a menu and a toolbar"
*/