diff options
-rw-r--r-- | doc/config/compat.qdocconf | 31 | ||||
-rw-r--r-- | doc/config/installerfw-project.qdocconf | 49 | ||||
-rw-r--r-- | doc/config/macros.qdocconf | 43 | ||||
-rw-r--r-- | doc/config/qt-cpp-ignore.qdocconf | 99 | ||||
-rw-r--r-- | doc/config/qt-defines.qdocconf | 19 | ||||
-rw-r--r-- | doc/config/qt-html-default-styles.qdocconf | 61 | ||||
-rw-r--r-- | doc/config/qt-html-online-styles.qdocconf | 104 | ||||
-rw-r--r-- | doc/config/qt-html-templates-online.qdocconf | 173 | ||||
-rw-r--r-- | doc/config/qt-html-templates.qdocconf | 66 | ||||
-rw-r--r-- | doc/doc.pri | 14 | ||||
-rw-r--r-- | doc/installerfw-online.qdocconf | 4 | ||||
-rw-r--r-- | doc/installerfw.qdocconf | 54 |
12 files changed, 53 insertions, 664 deletions
diff --git a/doc/config/compat.qdocconf b/doc/config/compat.qdocconf deleted file mode 100644 index fe793de6b..000000000 --- a/doc/config/compat.qdocconf +++ /dev/null @@ -1,31 +0,0 @@ -alias.i = e - -macro.li = "\\o" -macro.0 = "\\\\0" -macro.b = "\\bold" -macro.n = "\\\\n" -macro.r = "\\\\r" -macro.i = "\\o" -macro.i11 = "\\o{1,1}" -macro.i12 = "\\o{1,2}" -macro.i13 = "\\o{1,3}" -macro.i14 = "\\o{1,4}" -macro.i15 = "\\o{1,5}" -macro.i16 = "\\o{1,6}" -macro.i17 = "\\o{1,7}" -macro.i18 = "\\o{1,8}" -macro.i19 = "\\o{1,9}" -macro.i21 = "\\o{2,1}" -macro.i31 = "\\o{3,1}" -macro.i41 = "\\o{4,1}" -macro.i51 = "\\o{5,1}" -macro.i61 = "\\o{6,1}" -macro.i71 = "\\o{7,1}" -macro.i81 = "\\o{8,1}" -macro.i91 = "\\o{9,1}" -macro.img = "\\image" -macro.endquote = "\\endquotation" -macro.relatesto = "\\relates" - -spurious = "Missing comma in .*" \ - "Missing pattern .*" diff --git a/doc/config/installerfw-project.qdocconf b/doc/config/installerfw-project.qdocconf deleted file mode 100644 index fc0074d8c..000000000 --- a/doc/config/installerfw-project.qdocconf +++ /dev/null @@ -1,49 +0,0 @@ -project = "Qt Installer Framework" -description = "Qt Installer Framework Manual" - -headerdirs = -sourcedirs = $SRCDIR - -# Contains documentation for JS API -sources = $SRCDIR/../src/libs/installer/packagemanagercore.cpp \ - $SRCDIR/../src/libs/installer/component.cpp \ - $SRCDIR/../src/libs/installer/messageboxhandler.cpp - -imagedirs = $SRCDIR/images $SRCDIR/templates/images -outputdir = $OUTDIR -exampledirs = $SRCDIR $SRCDIR/examples -indexes = qt.index - -include(compat.qdocconf) -include(macros.qdocconf) -include(qt-cpp-ignore.qdocconf) -include(qt-defines.qdocconf) - -sources.fileextensions = "*.qdoc *.cpp" - -qhp.projects = InstallerFramework -qhp.InstallerFramework.file = ifw.qhp -qhp.InstallerFramework.namespace = org.qt-project.ifw.$IFW_VERSION_TAG -qhp.InstallerFramework.virtualFolder = doc -qhp.InstallerFramework.indexTitle = Qt Installer Framework Manual -qhp.InstallerFramework.filterAttributes = ifw -qhp.InstallerFramework.customFilters.InstallerFramework.name = Installer Framework -qhp.InstallerFramework.customFilters.InstallerFramework.filterAttributes = ifw -qhp.InstallerFramework.indexRoot = - -qhp.InstallerFramework.subprojects = manual -qhp.InstallerFramework.subprojects.manual.title = Qt Installer Framework Manual -qhp.InstallerFramework.subprojects.manual.indexTitle = Qt Installer Framework Manual -qhp.InstallerFramework.subprojects.manual.type = manual - -# Doxygen compatibility commands - -macro.see = "\\sa" -macro.function = "\\fn" - - -# We 'misuse' QML doc commands to generate JS documentation -# (only works with qdoc from Qt 5) - -outputprefixes = QML -outputprefixes.QML = diff --git a/doc/config/macros.qdocconf b/doc/config/macros.qdocconf deleted file mode 100644 index f8ce76899..000000000 --- a/doc/config/macros.qdocconf +++ /dev/null @@ -1,43 +0,0 @@ -macro.aacute.HTML = "á" -macro.Aring.HTML = "Å" -macro.aring.HTML = "å" -macro.Auml.HTML = "Ä" -macro.author = "\\b{Author:}" -macro.br.HTML = "<br />" -macro.BR.HTML = "<br />" -macro.copyright.HTML = "©" -macro.eacute.HTML = "é" -macro.gui = "\\b" -macro.hr.HTML = "<hr />" -macro.iacute.HTML = "í" -macro.key = "\\b" -macro.menu = "\\b" -macro.note = "\\b{Note:}" -macro.oslash.HTML = "ø" -macro.ouml.HTML = "ö" -macro.QA = "Qt Assistant" -macro.QC = "Qt Creator" -macro.QD = "Qt Designer" -macro.QL = "Qt Linguist" -macro.QMLD = "Qt Quick Designer" -macro.QQV = "Qt QML Viewer" -macro.QS = "Qt Simulator" -macro.QSDK = "Qt SDK" -macro.param = "\\e" -macro.raisedaster.HTML = "<sup>*</sup>" -macro.rarrow.HTML = "→" -macro.reg.HTML = "<sup>®</sup>" -macro.return = "Returns" -macro.starslash = "\\c{*/}" -macro.begincomment = "\\c{/*}" -macro.endcomment = "\\c{*/}" -macro.uuml.HTML = "ü" -macro.mdash.HTML = "—" - -macro.beginfloatleft.HTML = "<div style=\"float: left; margin-right: 2em\">" -macro.beginfloatright.HTML = "<div style=\"float: right; margin-left: 2em\">" -macro.endfloat.HTML = "</div>" -macro.clearfloat.HTML = "<br style=\"clear: both\" />" -macro.emptyspan.HTML = "<span></span>" - -macro.ifwversion = $IFW_VERSION diff --git a/doc/config/qt-cpp-ignore.qdocconf b/doc/config/qt-cpp-ignore.qdocconf deleted file mode 100644 index ce8de2406..000000000 --- a/doc/config/qt-cpp-ignore.qdocconf +++ /dev/null @@ -1,99 +0,0 @@ -Cpp.ignoretokens = QAXFACTORY_EXPORT \ - QDESIGNER_COMPONENTS_LIBRARY \ - QDESIGNER_EXTENSION_LIBRARY \ - QDESIGNER_SDK_LIBRARY \ - QDESIGNER_SHARED_LIBRARY \ - QDESIGNER_UILIB_LIBRARY \ - QM_EXPORT_CANVAS \ - QM_EXPORT_DNS \ - QM_EXPORT_DOM \ - QM_EXPORT_FTP \ - QM_EXPORT_HTTP \ - QM_EXPORT_ICONVIEW \ - QM_EXPORT_NETWORK \ - QM_EXPORT_OPENGL \ - QM_EXPORT_OPENVG \ - QM_EXPORT_SQL \ - QM_EXPORT_TABLE \ - QM_EXPORT_WORKSPACE \ - QM_EXPORT_XML \ - QT_ASCII_CAST_WARN \ - QT_ASCII_CAST_WARN_CONSTRUCTOR \ - QT_BEGIN_HEADER \ - QT_DESIGNER_STATIC \ - QT_END_HEADER \ - QT_FASTCALL \ - QT_WIDGET_PLUGIN_EXPORT \ - Q_COMPAT_EXPORT \ - Q_CORE_EXPORT \ - Q_CORE_EXPORT_INLINE \ - Q_EXPLICIT \ - Q_EXPORT \ - Q_EXPORT_CODECS_CN \ - Q_EXPORT_CODECS_JP \ - Q_EXPORT_CODECS_KR \ - Q_EXPORT_PLUGIN \ - Q_GFX_INLINE \ - Q_AUTOTEST_EXPORT \ - Q_GUI_EXPORT \ - Q_GUI_EXPORT_INLINE \ - Q_GUI_EXPORT_STYLE_CDE \ - Q_GUI_EXPORT_STYLE_COMPACT \ - Q_GUI_EXPORT_STYLE_MAC \ - Q_GUI_EXPORT_STYLE_MOTIF \ - Q_GUI_EXPORT_STYLE_MOTIFPLUS \ - Q_GUI_EXPORT_STYLE_PLATINUM \ - Q_GUI_EXPORT_STYLE_POCKETPC \ - Q_GUI_EXPORT_STYLE_SGI \ - Q_GUI_EXPORT_STYLE_WINDOWS \ - Q_GUI_EXPORT_STYLE_WINDOWSXP \ - QHELP_EXPORT \ - Q_INLINE_TEMPLATE \ - Q_INTERNAL_WIN_NO_THROW \ - Q_NETWORK_EXPORT \ - Q_OPENGL_EXPORT \ - Q_OPENVG_EXPORT \ - Q_OUTOFLINE_TEMPLATE \ - Q_SQL_EXPORT \ - Q_SVG_EXPORT \ - Q_SCRIPT_EXPORT \ - Q_SCRIPTTOOLS_EXPORT \ - Q_TESTLIB_EXPORT \ - Q_TYPENAME \ - Q_XML_EXPORT \ - Q_XMLSTREAM_EXPORT \ - Q_XMLPATTERNS_EXPORT \ - QDBUS_EXPORT \ - Q_DBUS_EXPORT \ - QT_BEGIN_NAMESPACE \ - QT_BEGIN_INCLUDE_NAMESPACE \ - QT_END_NAMESPACE \ - QT_END_INCLUDE_NAMESPACE \ - PHONON_EXPORT \ - Q_DECLARATIVE_EXPORT \ - Q_GADGET \ - QWEBKIT_EXPORT \ - Q_INVOKABLE \ - EXTENSIONSYSTEM_EXPORT -Cpp.ignoredirectives = Q_DECLARE_HANDLE \ - Q_DECLARE_INTERFACE \ - Q_DECLARE_METATYPE \ - Q_DECLARE_OPERATORS_FOR_FLAGS \ - Q_DECLARE_PRIVATE \ - Q_DECLARE_PUBLIC \ - Q_DECLARE_SHARED \ - Q_DECLARE_TR_FUNCTIONS \ - Q_DECLARE_TYPEINFO \ - Q_DISABLE_COPY \ - QT_FORWARD_DECLARE_CLASS \ - Q_DUMMY_COMPARISON_OPERATOR \ - Q_ENUMS \ - Q_FLAGS \ - Q_INTERFACES \ - __attribute__ \ - K_DECLARE_PRIVATE \ - PHONON_OBJECT \ - PHONON_HEIR \ - Q_PRIVATE_PROPERTY \ - Q_DECLARE_PRIVATE_D \ - Q_CLASSINFO diff --git a/doc/config/qt-defines.qdocconf b/doc/config/qt-defines.qdocconf deleted file mode 100644 index 1ce9a8045..000000000 --- a/doc/config/qt-defines.qdocconf +++ /dev/null @@ -1,19 +0,0 @@ -defines = Q_QDOC \ - QT_.*_SUPPORT \ - QT_.*_LIB \ - QT_COMPAT \ - QT_KEYPAD_NAVIGATION \ - QT_NO_EGL \ - QT3_SUPPORT \ - Q_WS_.* \ - Q_OS_.* \ - Q_BYTE_ORDER \ - QT_DEPRECATED \ - Q_NO_USING_KEYWORD \ - __cplusplus \ - qtquick \ - qcmanual - -versionsym = QT_VERSION_STR - -codeindent = 1 diff --git a/doc/config/qt-html-default-styles.qdocconf b/doc/config/qt-html-default-styles.qdocconf deleted file mode 100644 index 1530c158a..000000000 --- a/doc/config/qt-html-default-styles.qdocconf +++ /dev/null @@ -1,61 +0,0 @@ -# Define the location of the templates to use. Style sheets and scripts are -# specified relative to the template directory and will be copied into -# subdirectories of the output directory. - -HTML.templatedir = $SRCDIR/config - -HTML.stylesheets = ../templates/style/offline.css - -HTML.scripts = - -# Files not referenced in any qdoc file (last four needed by qtdemo) -# See also qhp.Qt.extraFiles -# for Qt 4: -extraimages.HTML = ../templates/images/qt-logo.png \ - ../templates/images/arrow_down.png \ - ../templates/images/breadcrumb.png \ - ../templates/images/bullet_gt.png \ - ../templates/images/bullet_dn.png \ - ../templates/images/bullet_sq.png \ - ../templates/images/bullet_up.png \ - ../templates/images/horBar.png \ - ../templates/images/sprites-combined.png \ - ../templates/images/bgrContent.png \ - ../templates/images/blu_dot.png \ - ../templates/images/btn_next.png \ - ../templates/images/btn_prev.png \ - ../templates/images/ico_note.png \ - ../templates/images/ico_note_attention.png \ - ../templates/images/ico_out.png \ - ../templates/images/arrow_bc.png \ - ../templates/images/home.png -# for Qt 5 -HTML.extraimages = ../templates/images/qt-logo.png \ - ../templates/images/arrow_down.png \ - ../templates/images/breadcrumb.png \ - ../templates/images/bullet_gt.png \ - ../templates/images/bullet_dn.png \ - ../templates/images/bullet_sq.png \ - ../templates/images/bullet_up.png \ - ../templates/images/horBar.png \ - ../templates/images/sprites-combined.png \ - ../templates/images/bgrContent.png \ - ../templates/images/blu_dot.png \ - ../templates/images/btn_next.png \ - ../templates/images/btn_prev.png \ - ../templates/images/ico_note.png \ - ../templates/images/ico_note_attention.png \ - ../templates/images/ico_out.png \ - ../templates/images/arrow_bc.png \ - ../templates/images/home.png - -# Include the style sheets and scripts used. - -HTML.headerstyles = \ - " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/offline.css\" />\n" - -HTML.headerscripts = - -HTML.endheader = \ - "</head>\n" \ - "<body>\n" diff --git a/doc/config/qt-html-online-styles.qdocconf b/doc/config/qt-html-online-styles.qdocconf deleted file mode 100644 index 56b05dd30..000000000 --- a/doc/config/qt-html-online-styles.qdocconf +++ /dev/null @@ -1,104 +0,0 @@ -# Define the location of the templates to use. Style sheets and scripts are -# specified relative to the template directory and will be copied into -# subdirectories of the output directory. - -HTML.templatedir = $SRCDIR/config - -HTML.stylesheets = ../templates/style/narrow.css \ - ../templates/style/style.css \ - ../templates/style/style_ie6.css \ - ../templates/style/style_ie7.css \ - ../templates/style/style_ie8.css \ - ../templates/style/superfish.css - -# Adding jquery and functions - providing online tools and search features -HTML.scripts = ../templates/scripts/functions.js \ - ../templates/scripts/narrow.js \ - ../templates/scripts/superfish.js \ - ../templates/scripts/jquery.js - - -# Files not referenced in any qdoc file. -# See also qhp.Qt.extraFiles -# for Qt 4 -extraimages.HTML = ../templates/images/qt-logo.png \ - ../templates/images/bg_l.png \ - ../templates/images/bg_l_blank.png \ - ../templates/images/bg_ll_blank.png \ - ../templates/images/bg_ul_blank.png \ - ../templates/images/btn_next_green.png \ - ../templates/images/btn_prev_green.png \ - ../templates/images/header_bg.png \ - ../templates/images/bg_r.png \ - ../templates/images/box_bg.png \ - ../templates/images/breadcrumb.png \ - ../templates/images/btn_next_green.png \ - ../templates/images/btn_prev_green.png \ - ../templates/images/bullet_gt.png \ - ../templates/images/bullet_dn.png \ - ../templates/images/bullet_sq.png \ - ../templates/images/bullet_up.png \ - ../templates/images/arrow_down.png \ - ../templates/images/feedbackground.png \ - ../templates/images/horBar.png \ - ../templates/images/page.png \ - ../templates/images/page_bg.png \ - ../templates/images/sprites-combined.png \ - ../templates/images/spinner.gif \ - ../templates/images/qtcreator-screenshots.png -# for Qt 5 -HTML.extraimages = ../templates/images/qt-logo.png \ - ../templates/images/bg_l.png \ - ../templates/images/bg_l_blank.png \ - ../templates/images/bg_ll_blank.png \ - ../templates/images/bg_ul_blank.png \ - ../templates/images/btn_next_green.png \ - ../templates/images/btn_prev_green.png \ - ../templates/images/header_bg.png \ - ../templates/images/bg_r.png \ - ../templates/images/box_bg.png \ - ../templates/images/breadcrumb.png \ - ../templates/images/btn_next_green.png \ - ../templates/images/btn_prev_green.png \ - ../templates/images/bullet_gt.png \ - ../templates/images/bullet_dn.png \ - ../templates/images/bullet_sq.png \ - ../templates/images/bullet_up.png \ - ../templates/images/arrow_down.png \ - ../templates/images/feedbackground.png \ - ../templates/images/horBar.png \ - ../templates/images/page.png \ - ../templates/images/page_bg.png \ - ../templates/images/sprites-combined.png \ - ../templates/images/spinner.gif \ - ../templates/images/qtcreator-screenshots.png - -# Include the style sheets and scripts used. - -HTML.headerstyles = \ - " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/style.css\" />\n" \ - " <script src=\"scripts/jquery.js\" type=\"text/javascript\"></script>\n" \ - " <script src=\"scripts/functions.js\" type=\"text/javascript\"></script>\n" \ - " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/superfish.css\" />\n" \ - " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/narrow.css\" />\n" \ - " <!--[if IE]>\n" \ - "<meta name=\"MSSmartTagsPreventParsing\" content=\"true\">\n" \ - "<meta http-equiv=\"imagetoolbar\" content=\"no\">\n" \ - "<![endif]-->\n" \ - "<!--[if lt IE 7]>\n" \ - "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/style_ie6.css\">\n" \ - "<![endif]-->\n" \ - "<!--[if IE 7]>\n" \ - "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/style_ie7.css\">\n" \ - "<![endif]-->\n" \ - "<!--[if IE 8]>\n" \ - "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/style_ie8.css\">\n" \ - "<![endif]-->\n\n" - -HTML.headerscripts = \ - "<script src=\"scripts/superfish.js\" type=\"text/javascript\"></script>\n" \ - "<script src=\"scripts/narrow.js\" type=\"text/javascript\"></script>\n\n" - -HTML.endheader = \ - "</head>\n" \ - "<body class=\"\" onload=\"CheckEmptyAndLoadList();\">\n" diff --git a/doc/config/qt-html-templates-online.qdocconf b/doc/config/qt-html-templates-online.qdocconf deleted file mode 100644 index edea2655d..000000000 --- a/doc/config/qt-html-templates-online.qdocconf +++ /dev/null @@ -1,173 +0,0 @@ -include(qt-html-online-styles.qdocconf) - -HTML.postheader = \ - " <div class=\"header\" id=\"qtdocheader\">\n" \ - " <div class=\"content\"> \n" \ - " <div id=\"nav-logo\">\n" \ - " <a href=\"index.html\">Home</a></div>\n" \ - " <a href=\"index.html\" class=\"qtref\"><span>Qt Installer Framework Manual</span></a>\n" \ - " <div id=\"narrowsearch\"></div>\n" \ - " <div id=\"nav-topright\">\n" \ - " <ul>\n" \ - " <li class=\"nav-topright-home\"><a href=\"http://qt.digia.com/\">Qt HOME</a></li>\n" \ - " <li class=\"nav-topright-dev\"><a href=\"http://wiki.qt-project.org/\">DEV</a></li>\n" \ - " <li class=\"nav-topright-doc nav-topright-doc-active\"><a href=\"http://qt-project.org/doc/\">\n" \ - " DOC</a></li>\n" \ - " <li class=\"nav-topright-blog\"><a href=\"http://blog.qt.digia.com/\">BLOG</a></li>\n" \ - " </ul>\n" \ - " </div>\n" \ - " <div id=\"shortCut\">\n" \ - " <ul>\n" \ - " <li class=\"shortCut-topleft-inactive\"><span><a href=\"index.html\">Qt Installer Framework</a></span></li>\n" \ - " </a></li>\n" \ - " </ul>\n" \ - " </div>\n" \ - " </div>\n" \ - " </div>\n" \ - " <div class=\"wrapper\">\n" \ - " <div class=\"hd\">\n" \ - " <span></span>\n" \ - " </div>\n" \ - " <div class=\"bd group\">\n" \ - " <div class=\"sidebar\">\n" \ - " <div class=\"box first bottombar\" id=\"lookup\">\n" \ - " <h2 title=\"API Lookup\">\n" \ - " API Lookup</h2>\n" \ - " <div id=\"list001\" class=\"list\">\n" \ - " <ul id=\"ul001\" >\n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/classes.html">Class index</a></li>\n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/functions.html">Function index</a></li>\n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/modules.html">Modules</a></li>\n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/namespaces.html">Namespaces</a></li>\n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/qtglobal.html">Global Declarations</a></li>\n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/qdeclarativeelements.html">QML elements</a></li>\n" \ - " </ul> \n" \ - " </div>\n" \ - " </div>\n" \ - " <div class=\"box bottombar\" id=\"topics\">\n" \ - " <h2 title=\"Qt Topics\"><span></span>\n" \ - " Qt Topics</h2>\n" \ - " <div id=\"list002\" class=\"list\">\n" \ - " <ul id=\"ul002\" >\n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/qt-basic-concepts.html">Programming with Qt</a></li> \n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/qtquick.html">Device UIs & Qt Quick</a></li> \n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/qt-gui-concepts.html">UI Design with Qt</a></li> \n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/developing-with-qt.html">Cross-platform and Platform-specific</a></li> \n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/platform-specific.html">Platform-specific info</a></li> \n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/technology-apis.html">Qt and Key Technologies</a></li> \n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/best-practices.html">Best Practices</a></li> \n" \ - " </ul> \n" \ - " </div>\n" \ - " </div>\n" \ - " <div class=\"box\" id=\"examples\">\n" \ - " <h2 title=\"Examples\"><span></span>\n" \ - " Examples</h2>\n" \ - " <div id=\"list003\" class=\"list\">\n" \ - " <ul id=\"ul003\">\n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/all-examples.html">Examples</a></li>\n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/tutorials.html">Tutorials</a></li>\n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/demos.html">Demos</a></li>\n" \ - " <li><a href="http://qt-project.org/doc/qt-4.8/qdeclarativeexamples.html">QML Examples</a></li>\n" \ - " </ul> \n" \ - " </div>\n" \ - " </div>\n" \ - " </div>\n" \ - " <div class=\"wrap\">\n" \ - " <div class=\"toolbar\">\n" \ - " <div class=\"breadcrumb toolblock\">\n" \ - " <ul>\n" \ - " <li class=\"first\"><a href=\"index.html\">Home</a></li>\n" \ - " <!-- Breadcrumbs go here -->\n" - -HTML.postpostheader = \ - " </ul>\n" \ - " </div>\n" \ - " <div class=\"toolbuttons toolblock\">\n" \ - " <ul>\n" \ - " <li id=\"smallA\" class=\"t_button\">A</li>\n" \ - " <li id=\"medA\" class=\"t_button active\">A</li>\n" \ - " <li id=\"bigA\" class=\"t_button\">A</li>\n" \ - " <li id=\"print\" class=\"t_button\"><a href=\"javascript:this.print();\">\n" \ - " <span>Print</span></a></li>\n" \ - " </ul>\n" \ - " </div>\n" \ - " </div>\n" \ - " <div class=\"content mainContent\">\n" - -HTML.footer = \ - " </div>\n" \ - " </div>\n" \ - " </div> \n" \ - " <div class=\"ft\">\n" \ - " <span></span>\n" \ - " </div>\n" \ - " </div> \n" \ - " <div class=\"footer\">\n" \ - " <p>\n" \ - " <p>\n" \ - " <acronym title=\"Copyright\">©</acronym> 2013 Digia Plc and/or its\n" \ - " subsidiaries. Documentation contributions included herein are the copyrights of\n" \ - " their respective owners.</p>\n" \ - " <br />\n" \ - " <p>\n" \ - " The documentation provided herein is licensed under the terms of the\n" \ - " <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU Free Documentation\n" \ - " License version 1.3</a> as published by the Free Software Foundation.</p>\n" \ - " <p>\n" \ - " Documentation sources may be obtained from <a href=\"http://www.qt-project.org\">\n" \ - " www.qt-project.org</a>.</p>\n" \ - " <br />\n" \ - " <p>\n" \ - " Digia, Qt and their respective logos are trademarks of Digia Plc \n" \ - " in Finland and/or other countries worldwide. All other trademarks are property\n" \ - " of their respective owners. <a title=\"Privacy Policy\"\n" \ - " href=\"http://en.gitorious.org/privacy_policy/\">Privacy Policy</a></p>\n" \ - " </div>\n" \ - "\n" \ - " <script src=\"scripts/functions.js\" type=\"text/javascript\"></script>\n" \ - " <script type=\"text/javascript\">\n" \ - " var _gaq = _gaq || [];\n" \ - " _gaq.push(['_setAccount', 'UA-4457116-5']);\n" \ - " _gaq.push(['_trackPageview']);\n" \ - " (function() {\n" \ - " var ga = document.createElement('script'); " \ - "ga.type = 'text/javascript'; ga.async = true;\n" \ - " ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + " \ - "'.google-analytics.com/ga.js';\n" \ - " var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\n" \ - " })();\n" \ - " </script>\n" - - -# Files not referenced in any qdoc file. -# See also extraimages.HTML -qhp.QtCreator.extraFiles = index.html \ - images/bg_l.png \ - images/bg_l_blank.png \ - images/bg_ll_blank.png \ - images/bg_ul_blank.png \ - images/header_bg.png \ - images/bg_r.png \ - images/box_bg.png \ - images/breadcrumb.png \ - images/bullet_gt.png \ - images/bullet_dn.png \ - images/bullet_sq.png \ - images/bullet_up.png \ - images/arrow_down.png \ - images/feedbackground.png \ - images/horBar.png \ - images/page.png \ - images/page_bg.png \ - images/sprites-combined.png \ - images/spinner.gif \ - scripts/functions.js \ - scripts/jquery.js \ - scripts/narrow.js \ - scripts/superfish.js \ - style/narrow.css \ - style/superfish.css \ - style/style_ie6.css \ - style/style_ie7.css \ - style/style_ie8.css \ - style/style.css diff --git a/doc/config/qt-html-templates.qdocconf b/doc/config/qt-html-templates.qdocconf deleted file mode 100644 index 2110b688c..000000000 --- a/doc/config/qt-html-templates.qdocconf +++ /dev/null @@ -1,66 +0,0 @@ -include(qt-html-default-styles.qdocconf) - -HTML.postheader = \ - "<div class=\"header\" id=\"qtdocheader\">\n" \ - " <div class=\"content\"> \n" \ - " <a href=\"index.html\" class=\"qtref\"><span>Qt Installer Framework Documentation</span></a>\n" \ - " </div>\n" \ - " <div class=\"breadcrumb\">\n" \ - " <ul>\n" \ - " <li class=\"first\"><a href=\"index.html\">Home</a></li>\n" \ - " <!-- Breadcrumbs go here -->\n" - -HTML.postpostheader = \ - "\n" \ - " </ul>\n" \ - " </div>\n" \ - "</div>\n" \ - "<div class=\"content mainContent\">\n" - -HTML.footer = \ - " <div class=\"ft\">\n" \ - " <span></span>\n" \ - " </div>\n" \ - "</div> \n" \ - "<div class=\"footer\">\n" \ - " <p>\n" \ - " <acronym title=\"Copyright\">©</acronym> 2013 Digia Plc and/or its\n" \ - " subsidiaries. Documentation contributions included herein are the copyrights of\n" \ - " their respective owners.</p>\n" \ - " <br />\n" \ - " <p>\n" \ - " The documentation provided herein is licensed under the terms of the\n" \ - " <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU Free Documentation\n" \ - " License version 1.3</a> as published by the Free Software Foundation.</p>\n" \ - " <p>\n" \ - " Documentation sources may be obtained from <a href=\"http://www.qt-project.org\">\n" \ - " www.qt-project.org</a>.</p>\n" \ - " <br />\n" \ - " <p>\n" \ - " Digia, Qt and their respective logos are trademarks of Digia Plc \n" \ - " in Finland and/or other countries worldwide. All other trademarks are property\n" \ - " of their respective owners. <a title=\"Privacy Policy\"\n" \ - " href=\"http://en.gitorious.org/privacy_policy/\">Privacy Policy</a></p>\n" \ - "</div>\n" \ - -# Files not referenced in any qdoc file. -# See also extraimages.HTML -qhp.InstallerFramework.extraFiles = index.html \ - images/arrow_down.png \ - images/breadcrumb.png \ - images/bullet_gt.png \ - images/bullet_dn.png \ - images/bullet_sq.png \ - images/bullet_up.png \ - images/horBar.png \ - images/sprites-combined.png \ - images/bgrContent.png \ - images/blu_dot.png \ - images/btn_next.png \ - images/btn_prev.png \ - images/ico_note.png \ - images/ico_note_attention.png \ - images/ico_out.png \ - images/home.png \ - images/arrow_bc.png \ - style/offline.css diff --git a/doc/doc.pri b/doc/doc.pri index adf1bc56d..428b5a535 100644 --- a/doc/doc.pri +++ b/doc/doc.pri @@ -33,23 +33,13 @@ HELP_DEP_FILES = $$PWD/installerfw.qdoc \ $$PWD/operations.qdoc \ $$PWD/scripting.qdoc \ $$PWD/tutorial.qdoc \ - $$PWD/installerfw.qdocconf \ - $$PWD/installerfw-online.qdocconf \ - $$PWD/config/compat.qdocconf \ - $$PWD/config/installerfw-project.qdocconf \ - $$PWD/config/macros.qdocconf \ - $$PWD/config/qt-cpp-ignore.qdocconf \ - $$PWD/config/qt-defines.qdocconf \ - $$PWD/config/qt-html-default-styles.qdocconf \ - $$PWD/config/qt-html-online-styles.qdocconf \ - $$PWD/config/qt-html-templates-online.qdocconf \ - $$PWD/config/qt-html-templates.qdocconf + $$PWD/installerfw.qdocconf html_docs.commands = $$QDOC $$PWD/installerfw.qdocconf html_docs.depends += $$HELP_DEP_FILES html_docs.files = $$QHP_FILE -html_docs_online.commands = $$QDOC $$PWD/installerfw-online.qdocconf +html_docs_online.commands = $$QDOC $$PWD/installerfw.qdocconf html_docs_online.depends += $$HELP_DEP_FILES html_docs_online.files = $$QHP_FILE diff --git a/doc/installerfw-online.qdocconf b/doc/installerfw-online.qdocconf deleted file mode 100644 index 2d04e92b1..000000000 --- a/doc/installerfw-online.qdocconf +++ /dev/null @@ -1,4 +0,0 @@ -# Run qdoc from the directory that contains this file. -include(config/installerfw-project.qdocconf) -include(config/qt-html-templates-online.qdocconf) - diff --git a/doc/installerfw.qdocconf b/doc/installerfw.qdocconf index 06edad086..af02e61f2 100644 --- a/doc/installerfw.qdocconf +++ b/doc/installerfw.qdocconf @@ -1,3 +1,51 @@ -# Run qdoc from the directory that contains this file. -include(config/installerfw-project.qdocconf) -include(config/qt-html-templates.qdocconf) +include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf) +include($QT_INSTALL_DOCS/global/macros.qdocconf) +include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf) +include($QT_INSTALL_DOCS/global/compat.qdocconf) +include($QT_INSTALL_DOCS/global/fileextensions.qdocconf) + +project = "Qt Installer Framework" +description = "Qt Installer Framework Manual" + +headerdirs = +sourcedirs = $SRCDIR + +# Contains documentation for JS API +sources = $SRCDIR/../src/libs/installer/packagemanagercore.cpp \ + $SRCDIR/../src/libs/installer/component.cpp \ + $SRCDIR/../src/libs/installer/messageboxhandler.cpp + +imagedirs = $SRCDIR/images $SRCDIR/templates/images +outputdir = $OUTDIR +exampledirs = $SRCDIR $SRCDIR/examples + +sources.fileextensions = "*.qdoc *.cpp" + +qhp.projects = InstallerFramework +qhp.InstallerFramework.file = ifw.qhp +qhp.InstallerFramework.namespace = org.qt-project.ifw.$IFW_VERSION_TAG +qhp.InstallerFramework.virtualFolder = doc +qhp.InstallerFramework.indexTitle = Qt Installer Framework Manual +qhp.InstallerFramework.filterAttributes = ifw +qhp.InstallerFramework.customFilters.InstallerFramework.name = Installer Framework +qhp.InstallerFramework.customFilters.InstallerFramework.filterAttributes = ifw +qhp.InstallerFramework.indexRoot = + +qhp.InstallerFramework.subprojects = manual +qhp.InstallerFramework.subprojects.manual.title = Qt Installer Framework Manual +qhp.InstallerFramework.subprojects.manual.indexTitle = Qt Installer Framework Manual +qhp.InstallerFramework.subprojects.manual.type = manual + +macro.ifwversion = $IFW_VERSION + +# Doxygen compatibility commands + +macro.see = "\\sa" +macro.function = "\\fn" + + +# We 'misuse' QML doc commands to generate JS documentation +# (only works with qdoc from Qt 5) + +outputprefixes = QML +outputprefixes.QML = |