Add documentation template.

sifteo · May 11, 2013 · eee91d9 · eee91d9
1 parent 833260b
commit eee91d9
Show file tree

Hide file tree

Showing 34 changed files with 770 additions and 0 deletions.
diff --git a/doc/config/qt-html-templates-offline.qdocconf 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 = \
+    "  <link rel=\"stylesheet\" type=\"text/css\" href=\"style/offline.css\" />\n"
+
+HTML.endheader = \
+    "</head>\n" \
+    "<body>\n" \
+    "<div class=\"header\" id=\"qtdocheader\"></div>\n"\
+    "<div class=\"content\">\n" \
+    "<div class=\"line\">\n" \
+    "<div class=\"content mainContent\">\n" \
+
+HTML.footer = \
+    "</div>\n" \
+    "</div>\n" \
+    "</div>\n" \
+    "<div class=\"footer\">\n" \
+    "    <p>\n" \
+    "      <acronym title=\"Copyright\">&copy;</acronym> 2012-2013 Sifteo Inc. All rights reserved." \
+    "    </p>\n" \
+    "</div>\n" \
diff --git a/doc/config/qtxupdate.qdocconf 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
diff --git a/doc/config/template/images/arrow_down.png b/doc/config/template/images/arrow_down.png
diff --git a/doc/config/template/images/bg_l.png b/doc/config/template/images/bg_l.png
diff --git a/doc/config/template/images/bg_l_blank.png b/doc/config/template/images/bg_l_blank.png
diff --git a/doc/config/template/images/bg_ll_blank.png b/doc/config/template/images/bg_ll_blank.png
diff --git a/doc/config/template/images/bg_r.png b/doc/config/template/images/bg_r.png
diff --git a/doc/config/template/images/bg_ul_blank.png b/doc/config/template/images/bg_ul_blank.png
diff --git a/doc/config/template/images/bgrContent.png b/doc/config/template/images/bgrContent.png
diff --git a/doc/config/template/images/blu_dot.png b/doc/config/template/images/blu_dot.png
diff --git a/doc/config/template/images/box_bg.png b/doc/config/template/images/box_bg.png
diff --git a/doc/config/template/images/breadcrumb.png b/doc/config/template/images/breadcrumb.png
diff --git a/doc/config/template/images/btn_next.png b/doc/config/template/images/btn_next.png
diff --git a/doc/config/template/images/btn_prev.png b/doc/config/template/images/btn_prev.png
diff --git a/doc/config/template/images/bullet_dn.png b/doc/config/template/images/bullet_dn.png
diff --git a/doc/config/template/images/bullet_gt.png b/doc/config/template/images/bullet_gt.png
diff --git a/doc/config/template/images/bullet_sq.png b/doc/config/template/images/bullet_sq.png
diff --git a/doc/config/template/images/bullet_up.png b/doc/config/template/images/bullet_up.png
diff --git a/doc/config/template/images/feedbackground.png b/doc/config/template/images/feedbackground.png
diff --git a/doc/config/template/images/header_bg.png b/doc/config/template/images/header_bg.png
diff --git a/doc/config/template/images/home.png b/doc/config/template/images/home.png
diff --git a/doc/config/template/images/horBar.png b/doc/config/template/images/horBar.png
diff --git a/doc/config/template/images/ico_note.png b/doc/config/template/images/ico_note.png
diff --git a/doc/config/template/images/ico_note_attention.png b/doc/config/template/images/ico_note_attention.png
diff --git a/doc/config/template/images/ico_out.png b/doc/config/template/images/ico_out.png
diff --git a/doc/config/template/images/page.png b/doc/config/template/images/page.png
diff --git a/doc/config/template/images/page_bg.png b/doc/config/template/images/page_bg.png
diff --git a/doc/config/template/images/spinner.gif b/doc/config/template/images/spinner.gif
diff --git a/doc/config/template/images/sprites-combined.png b/doc/config/template/images/sprites-combined.png