summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLuciano Wolf <luciano.wolf@openbossa.org>2010-06-01 13:59:07 -0300
committerLuciano Wolf <luciano.wolf@openbossa.org>2010-06-01 17:33:19 -0300
commit02f4a14bab2d2056097bb9f05ebbd7cb91da22d1 (patch)
tree489f4cf04e2047375dfc74e9ebf497a7f37542a0 /doc
parent3e7a66f0fcdfdadb98b120d239378a60bf1bed1c (diff)
downloadpyside-02f4a14bab2d2056097bb9f05ebbd7cb91da22d1.tar.gz
pyside-02f4a14bab2d2056097bb9f05ebbd7cb91da22d1.tar.xz
pyside-02f4a14bab2d2056097bb9f05ebbd7cb91da22d1.zip
Updating documentation to include QtDeclarative and support new features.
Reviewer: Hugo Parente Lima <hugo.lima@openbossa.org>, Renato Ara├║jo <renato.filho@openbossa.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/CMakeLists.txt3
-rw-r--r--doc/_templates/index.html6
-rw-r--r--doc/pyside.qdocconf11
3 files changed, 16 insertions, 4 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index faab176..7bad422 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -28,7 +28,7 @@ string(REGEX REPLACE "^Qt" "" module_name ${module})
string(TOLOWER ${module_name} module_name)
add_custom_target("${module}-apidoc"
COMMAND ${GENERATOR} --generatorSet=qtdoc
- ${pyside_SOURCE_DIR}/global.h
+ ${pyside_BINARY_DIR}/global.h
--include-paths=${QT_INCLUDE_DIR}:${QT_QTCORE_INCLUDE_DIR}
--typesystem-paths=${pyside_SOURCE_DIR}:${${module}_BINARY_DIR}:${typesystem_path}
${pyside_SOURCE_DIR}/${module}/typesystem_${module_name}.xml
@@ -61,6 +61,7 @@ create_doc(QtScriptTools "${QtCore_SOURCE_DIR}:${QtScript_SOURCE_DIR}:${QtGui_SO
create_doc(QtTest "${QtCore_SOURCE_DIR}:${QtGui_SOURCE_DIR}:${QtGui_BINARY_DIR}")
create_doc(QtXmlPatterns "${QtCore_SOURCE_DIR}")
create_doc(phonon "${QtCore_SOURCE_DIR}:${QtGui_SOURCE_DIR}:${QtGui_BINARY_DIR}")
+create_doc(QtDeclarative "${QtCore_SOURCE_DIR}:${QtGui_SOURCE_DIR}:${QtGui_BINARY_DIR}:${QtNetwork_SOURCE_DIR}")
#create devhelp file
add_custom_target(apidevhelp
diff --git a/doc/_templates/index.html b/doc/_templates/index.html
index 624f47c..e618231 100644
--- a/doc/_templates/index.html
+++ b/doc/_templates/index.html
@@ -37,16 +37,18 @@
<span class="linkdescr">core non-GUI functionality</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("PySide/QtGui/index") }}">QtGui</a><br/>
<span class="linkdescr">extends QtCore with GUI functionality.</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("PySide/QtDeclarative/index") }}">QtDeclarative</a><br/>
+ <span class="linkdescr">a declarative framework for building highly dynamic, custom user interfaces.</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("PySide/QtHelp/index") }}">QtHelp</a><br/>
<span class="linkdescr">provides classes for integrating online documentation in applications</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("PySide/QtMultimedia/index") }}">QtMultimedia</a><br/>
+ <span class="linkdescr">provides low-level multimedia functionality</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("PySide/QtNetwork/index") }}">QtNetwork</a><br/>
<span class="linkdescr">offers classes that allow you to write TCP/IP clients and servers</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("PySide/QtOpenGL/index") }}">QtOpenGL</a><br/>
<span class="linkdescr">offers classes that make it easy to use OpenGL in Qt applications</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("PySide/QtScript/index") }}">QtScript</a><br/>
<span class="linkdescr">provides classes for making Qt applications scriptable</span></p>
- <p class="biglink"><a class="biglink" href="{{ pathto("PySide/QtMultimedia/index") }}">QtMultimedia</a><br/>
- <span class="linkdescr"></span>provides low-level multimedia functionality</p>
</td>
<td width="50%">
<p class="biglink"><a class="biglink" href="{{ pathto("PySide/QtScriptTools/index") }}">QtScriptTools</a><br/>
diff --git a/doc/pyside.qdocconf b/doc/pyside.qdocconf
index 24a6f63..1e940fa 100644
--- a/doc/pyside.qdocconf
+++ b/doc/pyside.qdocconf
@@ -1,8 +1,17 @@
include(qt.qdocconf)
quotinginformation = true
+exampledirs = $QTDIR/doc/src \
+ $QTDIR/examples \
+ $QTDIR/examples/tutorials \
+ $QTDIR \
+ $QTDIR/qmake/examples \
+ $QTDIR/src/3rdparty/webkit/WebKit/qt/docs
+
imagedirs = $QTDIR/doc/src/images \
- $QTDIR/examples
+ $QTDIR/examples \
+ $QTDIR/doc/src/declarative/pics \
+ $QTDIR/doc/src/template/image
outputdir = @CMAKE_CURRENT_BINARY_DIR@/qt4xmldoc
outputformats = WebXML