summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorXizhi Zhu <xizhi.zhu@gmail.com>2012-08-15 18:45:18 +0300
committerQt by Nokia <qt-info@nokia.com>2012-08-15 19:18:14 +0200
commit92defcdcef4b17dfbca21c18de7eebac13219736 (patch)
tree908b8f2103e85516f0df55fb7bf84630bc1a36eb
parent1672ed2a37ab2d9cbfefeade855b3ebc8251e516 (diff)
Added initial docs.
Change-Id: If514258ced07640f93af84db149f57a6f8962d61 Reviewed-by: Xizhi Zhu <xizhi.zhu@gmail.com>
-rw-r--r--doc/config/qtdocgallery-dita.qdocconf33
-rw-r--r--doc/config/qtdocgallery.qdocconf79
-rw-r--r--doc/config/qtdocgallery_doc.pri25
-rwxr-xr-xdoc/config/style/qtdocgallery.css763
-rw-r--r--doc/src/gallery-module.qdoc59
-rw-r--r--doc/src/gallery.qdoc127
-rw-r--r--qtdocgallery.pro2
7 files changed, 1088 insertions, 0 deletions
diff --git a/doc/config/qtdocgallery-dita.qdocconf b/doc/config/qtdocgallery-dita.qdocconf
new file mode 100644
index 0000000..073477b
--- /dev/null
+++ b/doc/config/qtdocgallery-dita.qdocconf
@@ -0,0 +1,33 @@
+# Name of the project.
+project = Qt DocGallery
+
+# Directories in which to search for files to document and images.
+# By default set to the root directory of the project for sources
+# and headers and qdoc will therefore generate output for each file.
+# Images should be placed in <rootdir>/dic/images and examples in
+# <rootdir>/examples.
+# Paths are relative to the location of this file.
+exampledirs += ../src/examples \
+ ../.. \
+ ../../examples
+
+headerdirs += ../src \
+ ../../src
+
+imagedirs += ../src/images \
+
+sourcedirs += ../src \
+ ../../src
+
+
+
+
+#Do not change the variables after this line unless you know what you are doing.
+
+outputdir = ../ditaxml
+outputformats = DITAXML
+
+examples.fileextensions = "*.cpp *.h *.js *.svg *.xml *.ui *.qml"
+examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"
+headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
+sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
diff --git a/doc/config/qtdocgallery.qdocconf b/doc/config/qtdocgallery.qdocconf
new file mode 100644
index 0000000..f59f593
--- /dev/null
+++ b/doc/config/qtdocgallery.qdocconf
@@ -0,0 +1,79 @@
+# Name of the project.
+project = Qt DocGallery
+description = Qt DocGallery Documentation
+
+# Directories in which to search for files to document and images.
+# By default set to the root directory of the project for sources
+# and headers and qdoc will therefore generate output for each file.
+# Images should be placed in <rootdir>/dic/images and examples in
+# <rootdir>/examples.
+# Paths are relative to the location of this file.
+
+exampledirs += ../src/examples \
+ ../.. \
+ ../../examples
+
+headerdirs += ../src \
+ ../../src
+
+imagedirs += ../src/images \
+
+sourcedirs += ../src \
+ ../../src \
+ ../../examples
+
+#indexes = $QT5DOC/doc/html/qt.index
+
+# The following parameters are for creating a qhp file, the qhelpgenerator
+# program can convert the qhp file into a qch file which can be opened in
+# Qt Assistant and/or Qt Creator.
+
+# Defines the name of the project. You cannot use operators (+, =, -) in
+# the name. Properties for this project are set using a qhp.<projectname>.property
+# format.
+qhp.projects = qtdocgallery
+
+# Sets the name of the output qhp file.
+qhp.qtdocgallery.file = qtdocgallery.qhp
+
+# Namespace for the output file. This namespace is used to distinguish between
+# different documentation files in Creator/Assistant.
+qhp.qtdocgallery.namespace = qtdocgallery.500
+
+# Title for the package, will be the main title for the package in
+# Assistant/Creator.
+qhp.qtdocgallery.indexTitle = Qt DocGallery Documentation
+
+# Extra files to add to the output which are not linked to from anywhere
+# using a qdoc \l command.
+qhp.qtdocgallery.extraFiles = style/qtdocgallery.css \
+ index.html
+
+# Only update the name of the project for the next variables.
+qhp.qtdocgallery.virtualFolder = qdoc
+qhp.qtdocgallery.subprojects = classes
+qhp.qtdocgallery.subprojects.classes.title = Classes
+qhp.qtdocgallery.subprojects.classes.selectors = class fake:headerfile
+qhp.qtdocgallery.subprojects.classes.sortPages = true
+
+
+
+# Do NOT change the variables after this line unless you know what you are doing.
+
+outputdir = ../html
+outputformats = HTML
+
+examples.fileextensions = "*.cpp *.h *.js *.svg *.xml *.ui *.qml"
+examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"
+headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
+sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
+
+HTML.nobreadcrumbs = "true"
+
+HTML.templatedir = .
+HTML.stylesheets = style/qtdocgallery.css
+
+HTML.headerstyles = " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/qtdocgallery.css\" />\n"
+HTML.endheader = "</head>\n<body>\n"
+
+HTML.footer = "<div class=\"footer\">Copyright (C) 2012 Nokia Corporation and/or its subsidiaries. All rights reserved.</div>\n"
diff --git a/doc/config/qtdocgallery_doc.pri b/doc/config/qtdocgallery_doc.pri
new file mode 100644
index 0000000..f39adb3
--- /dev/null
+++ b/doc/config/qtdocgallery_doc.pri
@@ -0,0 +1,25 @@
+OTHER_FILES += \
+ $$PWD/qtdocgallery.qdocconf \
+ $$PWD/qtdocgallery-dita.qdocconf
+
+QDOC = $$QT.core.bins/qdoc
+
+ONLINE_CONF = $$PWD/qtdocgallery.qdocconf
+DITA_CONF = $$PWD/qtdocgallery-dita.qdocconf
+QCH_CONF = #nothing yet
+
+$$unixstyle {
+} else {
+ QDOC = $$replace(QDOC, "qdoc", "qdoc3.exe")
+ ONLINE_CONF = $$replace(ONLINE_CONF, "/", "\\")
+ DITA_DOCS = $$replace(ONLINE_CONF, "/", "\\")
+}
+
+qtdocgallery_online_docs.commands = $$QDOC $$ONLINE_CONF
+qtdocgallery_dita_docs.commands = $$QDOC $$DITA_CONF
+
+qtdocgallery_docs.depends = qtdocgallery_dita_docs qtdocgallery_online_docs
+QMAKE_EXTRA_TARGETS = qtdocgallery_docs qtdocgallery_dita_docs qtdocgallery_online_docs
+QMAKE_CLEAN += \
+ "-r $$PWD/html" \
+ "-r $$PWD/ditaxml"
diff --git a/doc/config/style/qtdocgallery.css b/doc/config/style/qtdocgallery.css
new file mode 100755
index 0000000..fe68f46
--- /dev/null
+++ b/doc/config/style/qtdocgallery.css
@@ -0,0 +1,763 @@
+@media screen
+{
+
+/* basic elements */
+ html
+ {
+ color: #000000;
+ background: #FFFFFF;
+ }
+ table
+ {
+ border-collapse: collapse;
+ border-spacing: 0;
+ }
+ fieldset, img
+ {
+ border: 0;
+ max-width:100%;
+ }
+ address, caption, cite, code, dfn, em, strong, th, var, optgroup
+ {
+ font-style: inherit;
+ font-weight: inherit;
+ }
+ del, ins
+ {
+ text-decoration: none;
+ }
+ ol li
+ {
+ list-style: decimal;
+ }
+ ul li
+ {
+ list-style: none;
+ }
+ caption, th
+ {
+ text-align: left;
+ }
+ h1, h2, h3, h4, h5, h6
+ {
+ font-size: 100%;
+ }
+ q:before, q:after
+ {
+ content: '';
+ }
+ abbr, acronym
+ {
+ border: 0;
+ font-variant: normal;
+ }
+ sup, sub
+ {
+ vertical-align: baseline;
+ }
+ tt, .qmlreadonly span, .qmldefault span
+ {
+ word-spacing:0.5em;
+ }
+ legend
+ {
+ color: #000000;
+ }
+ strong
+ {
+ font-weight: bold;
+ }
+ em
+ {
+ font-style: italic;
+ }
+
+ body
+ {
+ margin: 0px;
+ font-family: sans-serif;
+ line-height: normal
+ }
+ a
+ {
+ color: #00732F;
+ text-decoration: none;
+ }
+ hr
+ {
+ background-color: #E6E6E6;
+ border: 1px solid #E6E6E6;
+ height: 1px;
+ width: 100%;
+ text-align: left;
+ margin: 1.5em 0 1.5em 0;
+ }
+
+ pre
+ {
+ border: 1px solid #DDDDDD;
+ -moz-border-radius: 0.7em 0.7em 0.7em 0.7em;
+ -webkit-border-radius: 0.7em 0.7em 0.7em 0.7em;
+ border-radius: 0.7em 0.7em 0.7em 0.7em;
+ margin: 0 1.5em 1em 1em;
+ padding: 1em 1em 1em 1em;
+ overflow-x: auto;
+ }
+ table, pre
+ {
+ -moz-border-radius: 0.7em 0.7em 0.7em 0.7em;
+ -webkit-border-radius: 0.7em 0.7em 0.7em 0.7em;
+ border-radius: 0.7em 0.7em 0.7em 0.7em;
+ background-color: #F6F6F6;
+ border: 1px solid #E6E6E6;
+ border-collapse: separate;
+ margin-bottom: 2.5em;
+ }
+ pre {
+ font-size: 90%;
+ display: block;
+ overflow:hidden;
+ }
+ thead
+ {
+ margin-top: 0.5em;
+ font-weight: bold
+ }
+ th
+ {
+ padding: 0.5em 1.5em 0.5em 1em;
+ background-color: #E1E1E1;
+ border-left: 1px solid #E6E6E6;
+ }
+ td
+ {
+ padding: 0.25em 1.5em 0.25em 1em;
+ }
+
+ td.rightAlign
+ {
+ padding: 0.25em 0.5em 0.25em 1em;
+ }
+ table tr.odd
+ {
+ border-left: 1px solid #E6E6E6;
+ background-color: #F6F6F6;
+ color: black;
+ }
+ table tr.even
+ {
+ border-left: 1px solid #E6E6E6;
+ background-color: #ffffff;
+ color: #202020;
+ }
+
+ div.float-left
+ {
+ float: left; margin-right: 2em
+ }
+ div.float-right
+ {
+ float: right; margin-left: 2em
+ }
+
+ span.comment
+ {
+ color: #008B00;
+ }
+ span.string, span.char
+ {
+ color: #000084;
+ }
+ span.number
+ {
+ color: #a46200;
+ }
+ span.operator
+ {
+ color: #202020;
+ }
+ span.keyword
+ {
+ color: #840000;
+ }
+ span.name
+ {
+ color: black
+ }
+ span.type
+ {
+ font-weight: bold
+ }
+ span.type a:visited
+ {
+ color: #0F5300;
+ }
+ span.preprocessor
+ {
+ color: #404040
+ }
+/* end basic elements */
+
+/* font style elements */
+ .heading
+ {
+ font-weight: bold;
+ font-size: 125%;
+ }
+ .subtitle
+ {
+ font-size: 110%
+ }
+ .small-subtitle
+ {
+ font-size: 100%
+ }
+ .red
+ {
+ color:red;
+ }
+/* end font style elements */
+
+/* global settings*/
+ .header, .footer
+ {
+ display: block;
+ clear: both;
+ overflow: hidden;
+ }
+/* end global settings*/
+
+/* header elements */
+ .header .qtref
+ {
+ color: #00732F;
+ font-weight: bold;
+ font-size: 130%;
+ }
+
+ .header .content
+ {
+ margin-left: 5px;
+ margin-top: 5px;
+ margin-bottom: 0.5em;
+ }
+
+ .header .breadcrumb
+ {
+ font-size: 90%;
+ padding: 0.5em 0 0.5em 1em;
+ margin: 0;
+ background-color: #fafafa;
+ height: 1.35em;
+ border-bottom: 1px solid #d1d1d1;
+ }
+
+ .header .breadcrumb ul
+ {
+ margin: 0;
+ padding: 0;
+ }
+
+ .header .content
+ {
+ word-wrap: break-word;
+ }
+
+ .header .breadcrumb ul li
+ {
+ float: left;
+ background: url(../images/breadcrumb.png) no-repeat 0 3px;
+ padding-left: 1.5em;
+ margin-left: 1.5em;
+ }
+
+ .header .breadcrumb ul li.last
+ {
+ font-weight: normal;
+ }
+
+ .header .breadcrumb ul li a
+ {
+ color: #00732F;
+ }
+
+ .header .breadcrumb ul li.first
+ {
+ background-image: none;
+ padding-left: 0;
+ margin-left: 0;
+ }
+
+ .header .content ol li {
+ background: none;
+ margin-bottom: 1.0em;
+ margin-left: 1.2em;
+ padding-left: 0
+ }
+
+ .header .content li
+ {
+ background: url(../images/bullet_sq.png) no-repeat 0 5px;
+ margin-bottom: 1em;
+ padding-left: 1.2em;
+ }
+
+/* end header elements */
+
+/* content elements */
+ .content h1
+ {
+ font-weight: bold;
+ font-size: 130%
+ }
+
+ .content h2
+ {
+ font-weight: bold;
+ font-size: 120%;
+ width: 100%;
+ }
+ .content h3
+ {
+ font-weight: bold;
+ font-size: 110%;
+ width: 100%;
+ }
+ .content table p
+ {
+ margin: 0
+ }
+ .content ul
+ {
+ padding-left: 2.5em;
+ }
+ .content li
+ {
+ padding-top: 0.25em;
+ padding-bottom: 0.25em;
+ }
+ .content ul img {
+ vertical-align: middle;
+ }
+
+ .content a:visited
+ {
+ color: #4c0033;
+ text-decoration: none;
+ }
+
+ .content a:visited:hover
+ {
+ color: #4c0033;
+ text-decoration: underline;
+ }
+
+ a:hover
+ {
+ color: #4c0033;
+ text-decoration: underline;
+ }
+ descr p a
+ {
+ text-decoration: underline;
+ }
+
+ .descr p a:visited
+ {
+ text-decoration: underline;
+ }
+
+ .alphaChar{
+ width:95%;
+ background-color:#F6F6F6;
+ border:1px solid #E6E6E6;
+ -moz-border-radius: 7px 7px 7px 7px;
+ border-radius: 7px 7px 7px 7px;
+ -webkit-border-radius: 7px 7px 7px 7px;
+ font-size:12pt;
+ padding-left:10px;
+ margin-top:10px;
+ margin-bottom:10px;
+ }
+ .flowList{
+ /*vertical-align:top;*/
+ /*margin:20px auto;*/
+
+ column-count:3;
+ -webkit-column-count:3;
+ -moz-column-count:3;
+/*
+ column-width:100%;
+ -webkit-column-width:200px;
+ -col-column-width:200px;
+*/
+ column-gap:41px;
+ -webkit-column-gap:41px;
+ -moz-column-gap:41px;
+
+ column-rule: 1px dashed #ccc;
+ -webkit-column-rule: 1px dashed #ccc;
+ -moz-column-rule: 1px dashed #ccc;
+ }
+
+ .flowList dl{
+ }
+ .flowList dd{
+ /*display:inline-block;*/
+ margin-left:10px;
+ min-width:250px;
+ line-height: 1.5;
+ min-width:100%;
+ min-height:15px;
+ }
+
+ .flowList dd a{
+ }
+
+ .mainContent
+ {
+ padding-left:5px;
+ }
+
+ .content .flowList p{
+ padding:0px;
+ }
+
+ .content .alignedsummary
+ {
+ margin: 15px;
+ }
+
+
+ .qmltype
+ {
+ text-align: center;
+ font-size: 120%;
+ }
+ .qmlreadonly
+ {
+ padding-left: 5px;
+ float: right;
+ color: #254117;
+ }
+
+ .qmldefault
+ {
+ padding-left: 5px;
+ float: right;
+ color: red;
+ }
+
+ .qmldoc
+ {
+ }
+
+ .generic .alphaChar{
+ margin-top:5px;
+ }
+
+ .generic .odd .alphaChar{
+ background-color: #F6F6F6;
+ }
+
+ .generic .even .alphaChar{
+ background-color: #FFFFFF;
+ }
+
+ .memItemRight{
+ padding: 0.25em 1.5em 0.25em 0;
+ }
+ .highlightedCode
+ {
+ margin: 1.0em;
+ }
+ .annotated td {
+ padding: 0.25em 0.5em 0.25em 0.5em;
+ }
+
+ .toc
+ {
+ font-size: 80%
+ }
+
+ .header .content .toc ul
+ {
+ padding-left: 0px;
+ }
+
+ .content .toc h3 {
+ border-bottom: 0px;
+ margin-top: 0px;
+ }
+
+ .content .toc h3 a:hover {
+ color: #00732F;
+ text-decoration: none;
+ }
+
+ .content .toc .level2
+ {
+ margin-left: 1.5em;
+ }
+
+ .content .toc .level3
+ {
+ margin-left: 3.0em;
+ }
+
+ .content ul li
+ {
+ background: url(../images/bullet_sq.png) no-repeat 0 0.7em;
+ padding-left: 1em
+ }
+
+ .content .toc li
+ {
+ background: url(../images/bullet_dn.png) no-repeat 0 5px;
+ padding-left: 1em
+ }
+
+ .relpage
+ {
+ -moz-border-radius: 7px 7px 7px 7px;
+ -webkit-border-radius: 7px 7px 7px 7px;
+ border-radius: 7px 7px 7px 7px;
+ border: 1px solid #DDDDDD;
+ padding: 25px 25px;
+ clear: both;
+ }
+ .relpage ul
+ {
+ float: none;
+ padding: 1.5em;
+ }
+
+ h3.fn, span.fn
+ {
+ -moz-border-radius:7px 7px 7px 7px;
+ -webkit-border-radius:7px 7px 7px 7px;
+ border-radius:7px 7px 7px 7px;
+ background-color: #F6F6F6;
+ border-width: 1px;
+ border-style: solid;
+ border-color: #E6E6E6;
+ font-weight: bold;
+ word-spacing:3px;
+ padding:3px 5px;
+ }
+
+ .functionIndex {
+ font-size:12pt;
+ word-spacing:10px;
+ margin-bottom:10px;
+ background-color: #F6F6F6;
+ 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;
+ width:100%;
+ }
+
+ .centerAlign
+ {
+ text-align:center;
+ }
+
+ .rightAlign
+ {
+ text-align:right;
+ }
+
+ .leftAlign
+ {
+ text-align:left;
+ }
+
+ .topAlign{
+ vertical-align:top
+ }
+
+ .functionIndex a{
+ display:inline-block;
+ }
+
+/* end content elements */
+/* footer elements */
+
+ .footer
+ {
+ color: #393735;
+ font-size: 0.75em;
+ text-align: center;
+ padding-top: 1.5em;
+ padding-bottom: 1em;
+ background-color: #E6E7E8;
+ margin: 0;
+ }
+ .footer p
+ {
+ margin: 0.25em
+ }
+ .small
+ {
+ font-size: 0.5em;
+ }
+/* end footer elements */
+
+ .item {
+ float: left;
+ position: relative;
+ width: 100%;
+ overflow: hidden;
+ }
+
+
+ .item .primary {
+ margin-right: 220px;
+ position: relative;
+ }
+
+ .item hr {
+ margin-left: -220px;
+ }
+
+ .item .secondary {
+ float: right;
+ width: 200px;
+ position: relative;
+ }
+
+ .item .cols {
+ clear: both;
+ display: block;
+ }
+
+ .item .cols .col {
+ float: left;
+ margin-left: 1.5%;
+ }
+
+ .item .cols .col.first {
+ margin-left: 0;
+ }
+
+ .item .cols.two .col {
+ width: 45%;
+ }
+
+ .item .box {
+ margin: 0 0 10px 0;
+ }
+
+ .item .box h3 {
+ margin: 0 0 10px 0;
+ }
+
+ .cols.unclear {
+ clear:none;
+ }
+}
+
+/* end of screen media */
+
+/* start of print media */
+
+@media print
+{
+ input, textarea, .header, .footer, .toolbar, .feedback, .wrapper .hd, .wrapper .bd .sidebar, .wrapper .ft, #feedbackBox, #blurpage, .toc, .breadcrumb, .toolbar, .floatingResult
+ {
+ display: none;
+ background: none;
+ }
+ .content
+ {
+ background: none;
+ display: block;
+ width: 100%; margin: 0; float: none;
+ }
+}
+/* end of print media */
+
+
+/* modify the TOC layouts */
+div.toc ul {
+ padding-left: 20px;
+}
+div.toc li {
+ padding-left: 4px;
+}
+/* Remove the border around images*/
+a img
+{
+ border:none;
+}
+
+/*Add styling to the front pages*/
+
+.threecolumn_area
+{
+ padding-top: 20px;
+ padding-bottom: 20px;
+}
+.threecolumn_piece
+{
+ display: inline-block;
+ margin-left: 78px;
+ margin-top: 8px;
+ padding: 0;
+ vertical-align: top;
+ width: 25.5%;
+}
+div.threecolumn_piece ul {
+ list-style-type: none;
+ padding-left: 0px;
+ margin-top: 2px;
+}
+div.threecolumn_piece p {
+ margin-bottom: 7px;
+ color: #5C626E;
+ text-decoration: none;
+ font-weight: bold;
+}
+div.threecolumn_piece li {
+ padding-left: 0px;
+ margin-bottom: 5px;
+}
+div.threecolumn_piece a {
+ font-weight: normal;
+}
+/* Add style to guide page*/
+.fourcolumn_area
+{
+ padding-top: 20px;
+ padding-bottom: 20px;
+}
+.fourcolumn_piece
+{
+ display: inline-block;
+ margin-left: 35px;
+ margin-top: 8px;
+ padding: 0;
+ vertical-align: top;
+ width: 21.3%;
+}
+div.fourcolumn_piece ul {
+ list-style-type: none;
+ padding-left: 0px;
+ margin-top: 2px;
+}
+div.fourcolumn_piece p {
+ margin-bottom: 7px;
+ color: #40444D;
+ text-decoration: none;
+ font-weight: bold;
+}
+div.fourcolumn_piece li {
+ padding-left: 0px;
+ margin-bottom: 5px;
+}
+div.fourcolumn_piece a {
+ font-weight: normal;
+}
diff --git a/doc/src/gallery-module.qdoc b/doc/src/gallery-module.qdoc
new file mode 100644
index 0000000..b06d928
--- /dev/null
+++ b/doc/src/gallery-module.qdoc
@@ -0,0 +1,59 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \module QtDocGallery
+ \title Qt DocGallery Module
+ \ingroup modules
+
+ \brief DocGallery provides APIs to navigate and query documents using their
+ meta-data.
+
+ To use the module in Qt Quick you will need to load it with the command
+ \qml
+ import QtDocGallery 5.0
+ \endqml
+
+ For C++, to include the definitions of the module's classes, use the
+ following directive:
+
+ \code
+ #include <QtDocGallery>
+ \endcode
+
+ And for linking against the module add this to your qmake .pro file
+
+ \code
+ QT += docgallery
+ \endcode
+
+
+ See more in the \l{Qt DocGallery}{Qt DocGallery Overview}.
+
+*/
+
+
diff --git a/doc/src/gallery.qdoc b/doc/src/gallery.qdoc
new file mode 100644
index 0000000..a1229fd
--- /dev/null
+++ b/doc/src/gallery.qdoc
@@ -0,0 +1,127 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \group gallery
+ \title DocGallery Classes
+
+ A set of APIs to navigate and query documents using their meta-data.
+*/
+
+/*!
+ \page gallery.html
+ \title Qt DocGallery
+ \ingroup technology-apis
+ \brief An API to navigate and query documents using their meta-data.
+
+ The Qt DocGallery provides APIs to navigate and query documents using their
+ meta-data.
+
+ \tableofcontents
+
+ \section1 Overview
+
+ The Qt DocGallery provides an API for navigating and querying documents
+ using their meta-data. The common use case would be populating the media
+ selection views of a music player, or image viewer. It also provides APIs
+ for querying and editing the meta-data of individual documents.
+
+ Typically all files in user directories should be available in the
+ document gallery. The principal types are Audio, Video, Image, and
+ Document, but files can also be categorized as a File, Folder, Text,
+ or Playlist. There are also some meta-types composed from the meta-data
+ of files, these are Artist, Album, AudioGenre, and PhotoAlbum.
+
+ The document gallery API is composed of a set of asynchronous request
+ (\l QGalleryAbstractRequest) classes which talk to the system file indexing
+ service, this would be e.g. Tracker on certain Linux distributions, and
+ potentially Windows Search, or Spotlight on macs.
+ There are three requests; \l QGalleryQueryRequest takes a type, a parent
+ item, and some filtering criteria (\l QGalleryFilter) and returns
+ meta-data for all matching items.
+ \l QGalleryItemRequest takes an item ID and returns meta-data for just that
+ item. And \l QGalleryTypeRequest takes an item type and returns meta-data
+ describing that type.
+
+ The requests operate on implementations of the \l QAbstractGallery.
+ The default implementation is \l QDocumentGallery, but it's possible to
+ create alternative implementations which talk to a media server or web
+ services.
+
+ The primary interface to the results of a request is the
+ \l QGalleryResultSet class which provides accessors for reading and writing
+ the meta-data of a set of items.
+
+ A \l QGalleryResultSet cannot be created directly and may not need to be
+ accessed directly, instead an instance must be requested from a gallery
+ using one of the gallery request classes which typically also provide
+ convenience functions for accessing the items in a result set.
+
+
+ \section2 Requests
+
+ The gallery request classes inherit from \l QGalleryAbstractRequest and
+ are used to fetch items from a gallery, or to initiate service provided
+ by a gallery.
+
+ \annotatedlist gallery-requests
+
+
+ \section2 Filters
+
+ The filter classes provide a way to describe meta-data criteria items must
+ satisfy to be included in the results of some requests.
+
+ \annotatedlist gallery-filters
+
+
+ \section2 Galleries
+
+ The gallery classes provide instances of different gallery types. Currently
+ the only gallery type is the Document Gallery.
+
+ \annotatedlist gallery-galleries
+
+
+ \section2 QGalleryQueryModel
+
+ The \l QGalleryQueryModel class implements a QAbstractItemModel using
+ QGalleryQueryRequest. This is a convenience class which simplifies the
+ process of presenting gallery items in a list view.
+
+
+ \section2 \l QML Elements
+
+ QML elements providing access to the document gallery are implemented in
+ the \l {Gallery QML Plugin}.
+
+ \annotatedlist qml-gallery
+
+ \section1 Examples
+
+ \annotatedlist gallery-examples
+*/
diff --git a/qtdocgallery.pro b/qtdocgallery.pro
index 58c33f2..152ba9c 100644
--- a/qtdocgallery.pro
+++ b/qtdocgallery.pro
@@ -1 +1,3 @@
load(qt_parts)
+
+include(doc/config/qtdocgallery_doc.pri)