diff --git a/doc/config/qt-html-templates-offline.qdocconf b/doc/config/qt-html-templates-offline.qdocconf new file mode 100644 index 0000000..59b5b7e --- /dev/null +++ b/doc/config/qt-html-templates-offline.qdocconf @@ -0,0 +1,44 @@ +HTML.nobreadcrumbs = "true" + +HTML.stylesheets = template/style/offline.css +HTML.extraimages += template/images/ico_out.png \ + template/images/ico_note.png \ + template/images/ico_note_attention.png \ + template/images/btn_prev.png \ + template/images/btn_next.png \ + template/images/bullet_dn.png \ + template/images/bullet_sq.png \ + template/images/bgrContent.png + +#specify which files in the output directory should be packed into the qch file. +qhp.extraFiles += style/offline.css \ + images/ico_out.png \ + images/ico_note.png \ + images/ico_note_attention.png \ + images/btn_prev.png \ + images/btn_next.png \ + images/bullet_dn.png \ + images/bullet_sq.png \ + images/bgrContent.png + + +HTML.headerstyles = \ + " \n" + +HTML.endheader = \ + "\n" \ + "\n" \ + "
\n"\ + "
\n" \ + "
\n" \ + "
\n" \ + +HTML.footer = \ + "
\n" \ + "
\n" \ + "
\n" \ + "
\n" \ + "

\n" \ + " © 2012-2013 Sifteo Inc. All rights reserved." \ + "

\n" \ + "
\n" \ diff --git a/doc/config/qtxupdate.qdocconf b/doc/config/qtxupdate.qdocconf new file mode 100644 index 0000000..c73dae6 --- /dev/null +++ b/doc/config/qtxupdate.qdocconf @@ -0,0 +1,26 @@ +include(qt-html-templates-offline.qdocconf) + +project = QtxUpdate +description = QtxUpdate Documentation + +sourcedirs += ../src \ + ../../src + +headerdirs += ../src \ + ../../src + +exampledirs += ../../examples + +imagedirs += ./images + +excludedirs += + + +# Do NOT change the variables after this line unless you know what you are doing. + +outputformats = HTML + +sources.fileextensions = "*.cpp *.qdoc *.mm *.qml" +headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx" +examples.fileextensions = "*.cpp *.h *.js *.svg *.xml *.ui *.qml" +examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng" diff --git a/doc/config/template/images/arrow.png b/doc/config/template/images/arrow.png new file mode 100755 index 0000000..f2a83a5 Binary files /dev/null and b/doc/config/template/images/arrow.png differ diff --git a/doc/config/template/images/arrow_down.png b/doc/config/template/images/arrow_down.png new file mode 100644 index 0000000..9d01e97 Binary files /dev/null and b/doc/config/template/images/arrow_down.png differ diff --git a/doc/config/template/images/bg_l.png b/doc/config/template/images/bg_l.png new file mode 100755 index 0000000..90b1da1 Binary files /dev/null and b/doc/config/template/images/bg_l.png differ diff --git a/doc/config/template/images/bg_l_blank.png b/doc/config/template/images/bg_l_blank.png new file mode 100755 index 0000000..5a9673d Binary files /dev/null and b/doc/config/template/images/bg_l_blank.png differ diff --git a/doc/config/template/images/bg_ll_blank.png b/doc/config/template/images/bg_ll_blank.png new file mode 100644 index 0000000..95a1c45 Binary files /dev/null and b/doc/config/template/images/bg_ll_blank.png differ diff --git a/doc/config/template/images/bg_r.png b/doc/config/template/images/bg_r.png new file mode 100755 index 0000000..f0fb121 Binary files /dev/null and b/doc/config/template/images/bg_r.png differ diff --git a/doc/config/template/images/bg_ul_blank.png b/doc/config/template/images/bg_ul_blank.png new file mode 100644 index 0000000..7051261 Binary files /dev/null and b/doc/config/template/images/bg_ul_blank.png differ diff --git a/doc/config/template/images/bgrContent.png b/doc/config/template/images/bgrContent.png new file mode 100755 index 0000000..1a81b03 Binary files /dev/null and b/doc/config/template/images/bgrContent.png differ diff --git a/doc/config/template/images/blu_dot.png b/doc/config/template/images/blu_dot.png new file mode 100755 index 0000000..c332148 Binary files /dev/null and b/doc/config/template/images/blu_dot.png differ diff --git a/doc/config/template/images/box_bg.png b/doc/config/template/images/box_bg.png new file mode 100755 index 0000000..3322f92 Binary files /dev/null and b/doc/config/template/images/box_bg.png differ diff --git a/doc/config/template/images/breadcrumb.png b/doc/config/template/images/breadcrumb.png new file mode 100755 index 0000000..0ded551 Binary files /dev/null and b/doc/config/template/images/breadcrumb.png differ diff --git a/doc/config/template/images/btn_next.png b/doc/config/template/images/btn_next.png new file mode 100644 index 0000000..c649f18 Binary files /dev/null and b/doc/config/template/images/btn_next.png differ diff --git a/doc/config/template/images/btn_prev.png b/doc/config/template/images/btn_prev.png new file mode 100644 index 0000000..d1d2989 Binary files /dev/null and b/doc/config/template/images/btn_prev.png differ diff --git a/doc/config/template/images/bullet_dn.png b/doc/config/template/images/bullet_dn.png new file mode 100644 index 0000000..f776247 Binary files /dev/null and b/doc/config/template/images/bullet_dn.png differ diff --git a/doc/config/template/images/bullet_gt.png b/doc/config/template/images/bullet_gt.png new file mode 100755 index 0000000..7561b4e Binary files /dev/null and b/doc/config/template/images/bullet_gt.png differ diff --git a/doc/config/template/images/bullet_sq.png b/doc/config/template/images/bullet_sq.png new file mode 100755 index 0000000..a84845e Binary files /dev/null and b/doc/config/template/images/bullet_sq.png differ diff --git a/doc/config/template/images/bullet_up.png b/doc/config/template/images/bullet_up.png new file mode 100644 index 0000000..7de2f06 Binary files /dev/null and b/doc/config/template/images/bullet_up.png differ diff --git a/doc/config/template/images/feedbackground.png b/doc/config/template/images/feedbackground.png new file mode 100755 index 0000000..3a38d99 Binary files /dev/null and b/doc/config/template/images/feedbackground.png differ diff --git a/doc/config/template/images/header_bg.png b/doc/config/template/images/header_bg.png new file mode 100644 index 0000000..a436aa6 Binary files /dev/null and b/doc/config/template/images/header_bg.png differ diff --git a/doc/config/template/images/home.png b/doc/config/template/images/home.png new file mode 100755 index 0000000..8de6d0c Binary files /dev/null and b/doc/config/template/images/home.png differ diff --git a/doc/config/template/images/horBar.png b/doc/config/template/images/horBar.png new file mode 100755 index 0000000..100fe91 Binary files /dev/null and b/doc/config/template/images/horBar.png differ diff --git a/doc/config/template/images/ico_note.png b/doc/config/template/images/ico_note.png new file mode 100755 index 0000000..1379404 Binary files /dev/null and b/doc/config/template/images/ico_note.png differ diff --git a/doc/config/template/images/ico_note_attention.png b/doc/config/template/images/ico_note_attention.png new file mode 100755 index 0000000..b85b696 Binary files /dev/null and b/doc/config/template/images/ico_note_attention.png differ diff --git a/doc/config/template/images/ico_out.png b/doc/config/template/images/ico_out.png new file mode 100755 index 0000000..790a05e Binary files /dev/null and b/doc/config/template/images/ico_out.png differ diff --git a/doc/config/template/images/page.png b/doc/config/template/images/page.png new file mode 100644 index 0000000..1db151b Binary files /dev/null and b/doc/config/template/images/page.png differ diff --git a/doc/config/template/images/page_bg.png b/doc/config/template/images/page_bg.png new file mode 100755 index 0000000..9b3bd99 Binary files /dev/null and b/doc/config/template/images/page_bg.png differ diff --git a/doc/config/template/images/spinner.gif b/doc/config/template/images/spinner.gif new file mode 100644 index 0000000..1ed786f Binary files /dev/null and b/doc/config/template/images/spinner.gif differ diff --git a/doc/config/template/images/sprites-combined.png b/doc/config/template/images/sprites-combined.png new file mode 100755 index 0000000..3a48b21 Binary files /dev/null and b/doc/config/template/images/sprites-combined.png differ diff --git a/doc/config/template/style/offline.css b/doc/config/template/style/offline.css new file mode 100644 index 0000000..0e4dd5e --- /dev/null +++ b/doc/config/template/style/offline.css @@ -0,0 +1,667 @@ +body{ +font: normal 400 14px/1.2 Arial; +margin-top:85px; +font-family: Arial, Helvetica; +color:#313131; +text-align:justify; +margin-left:5px; +margin-right:5px; +} + +p { +line-height: 20px; +} +img{ +-moz-box-shadow: 3px 3px 3px #ccc; +-webkit-box-shadow: 3px 3px 3px #ccc; +box-shadow: 3px 3px 3px #ccc; +border:#8E8D8D 2px solid; +margin-left:0px; +max-width: 800px; +height: auto +} + +.content{} + +.descr{ +margin-top:35px; +/*max-width: 75%;*/ +margin-left:5px; +text-align:justify; +vertical-align:top; +} + +.name{ +max-width: 75%; +font-weight:100; +} + +tt{ +text-align:left;} + +/* +----------- +links +----------- +*/ + +a:link{ +color: #007330; +text-decoration: none; +text-align:left; +} + +a:hover{ +color: #44a51c; +text-align:left; +} + +a:visited{ +color: #007330; +text-align:left; +} + +a:visited:hover{ +color: #44a51c; +text-align:left; +} + +/* +----------- +offline viewing: HTML links display an icon +----------- +*/ +a[href*="http://"], a[href*="ftp://"],a[href*="https://"] +{ +text-decoration: none; +background-image:url(../images/ico_out.png); +background-repeat:no-repeat; +background-position:left; +padding-left:20px; +text-align:left; +} + +.flags{ +text-decoration:none; +text-height:24px; +} + +/* +------------------------------- +NOTE styles +------------------------------- +*/ +.notetitle, .tiptitle, .fastpathtitle{ +font-weight:bold; +} + +.attentiontitle,.cautiontitle,.dangertitle,.importanttitle,.remembertitle,.restrictiontitle{ +font-weight:bold; +} + +.note,.tip,.fastpath{ +background: #F2F2F2 url(../images/ico_note.png); +background-repeat: no-repeat; +background-position: top left; +padding:5px; +padding-left:40px; +padding-bottom:10px; +border:#999 1px dotted; +color:#666666; +margin:5px; +} + +.attention,.caution,.danger,.important,.remember,.restriction{ +background: #F2F2F2 url(../images/ico_note_attention.png); +background-repeat:no-repeat; +background-position:top left; +padding:5px; +padding-left:40px; +padding-bottom:10px; +border:#999 1px dotted; +color:#666666; +margin:5px; +} + +/* +------------------------------- +Top navigation +------------------------------- +*/ + +.qtref{ +display: block; +position: relative; +height:15px; +z-index: 1; +font-size:11px; +padding-right:10px; +float:right; +} + +.naviNextPrevious{ +clear: both; +display: block; +position: relative; +text-align: right; +top: -47px; +float:right; +height:20px; +z-index:1; +padding-right:10px; +padding-top:2px; +vertical-align:top; +margin:0px; +} + + +.naviNextPrevious > a:first-child{ +background-image:url(../images/btn_prev.png); +background-repeat:no-repeat; +background-position:left; +padding-left:20px; +height:20px; +padding-left:20px; +} + +.naviNextPrevious > a:last-child{ +background-image:url(../images/btn_next.png); +background-repeat:no-repeat; +background-position:right; +padding-right:20px; +height:20px; +margin-left:30px; +} +/* +----------- +footer and license +----------- +*/ +.footer{ +text-align:center +} + +/* table of content +no display +*/ + +/* +----------- +headers +----------- +*/ + + +@media screen{ +.title{ +color:#313131; +font-size: 18px; +font-weight: normal; +left: 0; +padding-bottom: 20px; +padding-left: 10px; +padding-top: 20px; +position: absolute; +right: 0; +top: 0; +background-color:#E6E6E6; +border-bottom: 1px #CCC solid; +border-top: 2px #CCC solid; +font-weight:bold; +margin-left:0px; +margin-right:0px; +} +} + +h1 { +margin: 0; +} + +h2, p.h2 { +font: 500 16px/1.2 Arial; +font-weight:100; +background-color:#F2F3F4; +padding:4px; +margin-bottom:30px; +margin-top:30px; +border-top:#E0E0DE 1px solid; +border-bottom: #E0E0DE 1px solid; +max-width: 99%; +overflow: hidden; +} + +h3{ + +font: 500 14px/1.2 Arial; +font-weight:100; +text-decoration:underline; +margin-bottom:30px; +margin-top:30px; +} + +h3.fn,span.fn{ +border-width: 1px; +border-style: solid; +border-color: #E6E6E6; +-moz-border-radius: 7px 7px 7px 7px; +-webkit-border-radius: 7px 7px 7px 7px; +border-radius: 7px 7px 7px 7px; +background-color: #F6F6F6; +word-spacing: 3px; +padding: 5px 5px; +text-decoration:none; +font-weight:bold; +max-width:75%; +font-size:14px; +margin:0px; +margin-top:45px; + +} + +.name{ +color:#1A1A1A; +} +.type{ +color:#808080; +} + + + +@media print { +.title { +color:#0066CB; +font-family:Arial, Helvetica; +font-size: 32px; +font-weight: normal; +left: 0; +position: absolute; +right: 0; +top: 0; +} +} + + +/* +----------------- +table styles +----------------- +*/ +.table img { +border:none; +margin-left:0px; +-moz-box-shadow:0px 0px 0px #fff; +-webkit-box-shadow: 0px 0px 0px #fff; +box-shadow: 0px 0px 0px #fff; +} + +/* table with border alternative colours*/ + + table,pre{ +-moz-border-radius: 7px 7px 7px 7px; +-webkit-border-radius: 7px 7px 7px 7px; + border-radius: 7px 7px 7px 7px; +background-color: #F6F6F6; +border: 1px solid #E6E6E6; +border-collapse: separate; +margin-bottom: 25px; +margin-left: 15px; +font-size: 12px; +line-height: 1.2; +} + + +table th{ +text-align:left; +padding-left:20px; +} + +table td { +padding: 3px 15px 3px 20px; +border-bottom:#CCC dotted 1px; +} +table p { margin:0px;} + +table tr.even { +background-color: white; +color: #66666E; +} + +table tr.odd { +background-color: #F6F6F6; +color: #66666E; +} + + +table thead { +text-align:left; +padding-left:20px; +background-color:#e1e0e0; +border-left:none; +border-right:none; +} + +table thead th { +padding-top:5px; +padding-left:10px; +padding-bottom:5px; +border-bottom: 2px solid #D1D1D1; +padding-right:10px; +} + + +/* table bodless & white*/ + +.borderless { +border-radius: 0px 0px 0px 0px; +background-color: #fff; +border: 1px solid #fff; +} + +.borderless tr { +background-color: #FFF; +color: #66666E; +} + +.borderless td { +border:none; +border-bottom:#fff dotted 1px; +} + +/* +----------- +List +----------- +*/ + +ul{ +padding-bottom:2px; +} + +li { +margin-bottom: 10px; +padding-left: 8px; +list-style:outside; +list-style-type:square; +text-align:left; +} + + +ol{ +margin:10px; +padding:0; +} + +ol > li{ +margin-left: 30px; +padding-left:8px; +list-style:decimal; +} + +.centerAlign{ +text-align: left; +} + +.cpp{ +display: block; +margin: 10px; +overflow: auto; +padding: 20px 20px 20px 20px; +} + +.js{ +display: block; +margin: 10px; +overflow: auto; +padding: 20px 20px 20px 20px; +} + +.footer{ +margin-top: 50px; +padding-left:5px; +margin-bottom: 10px; +font-size:10px; +border-top: 1px solid #999; +padding-top:11px; +} + +.footerNavi{ +width:auto; +text-align:right; +margin-top:50px; +z-index:1; +} + +.memItemLeft{ +padding-right: 3px; +} + +.memItemRight{ +padding: 3px 15px 3px 0; +} + +.qml{ +display: block; +margin: 10; +overflow: auto; +padding: 20px 20px 20px 20px; +} + +.qmldefault{ +padding-left: 5px; +float: right; +color: red; +} + +.qmlreadonly{ +padding-left: 5px; +float: right; +color: #254117; +} + +.rightAlign{ +padding: 3px 5px 3px 10px; +text-align: right; +} + +.qmldoc { +margin-left: 15px; +} +/* +----------- +Content table +----------- +*/ + +@media print{ +.toc { +float: right; +clear: right; +padding-bottom: 10px; +padding-top: 50px; +width: 100%; +background-image:url(../images/bgrContent.png); +background-position:top; +background-repeat:no-repeat; +} +} + +@media screen{ +.toc{ +float:right; +clear: right; +vertical-align:top; +-moz-border-radius: 7px 7px 7px 7px; +-webkit-border-radius: 7px 7px 7px 7px; +border-radius: 7px 7px 7px 7px; + background:#FFF url(../images/bgrContent.png); +background-position:top; +background-repeat:repeat-x; +border: 1px solid #E6E6E6; +padding-left:5px; +padding-bottom:10px; +height: auto; +width: 200px; +text-align:left; +margin-left:20px; +} +} + +.toc h3{ +text-decoration:none; +} + +.toc h3{font: 500 14px/1.2 Arial; +font-weight:100; +padding:0px; +margin:0px; +padding-top:5px; +padding-left:5px; +} + + +.toc ul{ +padding-left:10px; +padding-right:5px; +} + +.toc ul li{ +margin-left:15px; +list-style-image:url(../images/bullet_dn.png); +marker-offset: 0px; +margin-bottom:8px; +padding-left:0px; +} + +.toc .level1{ +border:none;} + +.toc .level2{ +border:none; +margin-left: 25px; +} + +.level3{ +border:none; +margin-left: 30px; +} + +.clearfix{ +clear:both;} + +/* start index box */ +.indexbox +{ +width: 100%; +display:inline-block; +} + +.indexboxcont +{ +display: block; + +} + +.indexboxcont .section +{ +display: inline-block; +width: 49%; +*width:42%; +_width:42%; +padding:0 2% 0 1%; +vertical-align:top; +} + +.indexboxcont .indexIcon +{ +width: 11%; +*width:18%; +_width:18%; +overflow:hidden; +} + +.indexboxcont .section { + float: left; +} + +.indexboxcont .section p +{ +padding-top: 20px; +padding-bottom: 20px; +} +.indexboxcont .sectionlist +{ +display: inline-block; +vertical-align:top; +width: 32.5%; +padding: 0; +} +.indexboxcont .sectionlist ul +{ +margin-bottom: 20px; +} + +.indexboxcont .sectionlist ul li +{ +line-height: 1.5; +} + +.content .indexboxcont li +{ +font: normal bold 13px/1 Verdana; +} + +.content .normallist li +{ +font: normal 13px/1 Verdana; +} + +.indexbox .indexIcon { +width: 11%; +} + +.indexbox .indexIcon span +{ +display: block; +} + +.indexboxcont:after +{ +content: "."; +display: block; +height: 0; +clear: both; +visibility: hidden; +} + +/* +----------- +Landing page +----------- +*/ +.col-group { + white-space: nowrap; + vertical-align: top; +} + +.col-1 { + display: inline-block; + white-space: normal; + width: 70%; + height: 100%; + float: left; +} + +.col-1 h1 { + margin: 20px 0 0 0; +} + +.col-2 { + display: inline-block; + white-space: normal; + width: 25%; + margin: 0 0 0 50px; +} + +.sectionlist { + width: 100% !important; +} diff --git a/doc/src/qtxupdate.qdoc b/doc/src/qtxupdate.qdoc new file mode 100644 index 0000000..f3cda6e --- /dev/null +++ b/doc/src/qtxupdate.qdoc @@ -0,0 +1,11 @@ +/*! + \module QtxUpdate + \title QtxUpdate + \brief The QtxUpdate module contains classes to make software update checks easier. + + To include the definitions of this module's classes, use the following directive: + + \code + #include + \endcode +*/ diff --git a/mkspecs/features/qtx_docs.prf b/mkspecs/features/qtx_docs.prf new file mode 100644 index 0000000..a184185 --- /dev/null +++ b/mkspecs/features/qtx_docs.prf @@ -0,0 +1,20 @@ +qtPrepareTool(QDOC, qdoc) + +__ROOT__ = $$dirname(_PRO_FILE_) +DOCS_MODULE = $$section($$list($$basename(_PRO_FILE_)), ., 0, 0) +DOCS_CONF = $$join(DOCS_MODULE,,$$join(__ROOT__,,,/doc/config/),.qdocconf) +DOCS_OUTPUTDIR = $$join(__ROOT__,,,/doc/$$DOCS_MODULE) + +QDOC += -outputdir $$DOCS_OUTPUTDIR +doc_command = $$QDOC $$DOCS_CONF + +DOC_TARGETS += prepare_docs generate_docs +prepare_docs.commands += $$doc_command -prepare -no-link-errors +generate_docs.commands += $$doc_command -generate +QMAKE_EXTRA_TARGETS += $$DOC_TARGETS + +html_docs.commands = $(MAKE) -f $(MAKEFILE) prepare_docs && $(MAKE) -f $(MAKEFILE) generate_docs +QMAKE_EXTRA_TARGETS += html_docs + +docs.commands = $(MAKE) -f $(MAKEFILE) html_docs +QMAKE_EXTRA_TARGETS += docs diff --git a/mkspecs/features/qtx_parts.prf b/mkspecs/features/qtx_parts.prf index afbdc3d..5867640 100644 --- a/mkspecs/features/qtx_parts.prf +++ b/mkspecs/features/qtx_parts.prf @@ -10,3 +10,5 @@ exists($$_PRO_FILE_PWD_/tests/tests.pro) { sub_tests.depends = sub_src # The tests may have a run-time only dependency on other parts SUBDIRS += sub_tests } + +include(qtx_docs.prf)