diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2018-02-06 13:15:35 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2018-02-13 09:20:07 +0000 |
| commit | 76d677df5eda91894336785789994790ff40b0f1 (patch) | |
| tree | 3bec009d42c80df168d953f2e982807700685690 /sources/pyside2/doc | |
| parent | 4e8f3f1a3a5d3987fb2a96d99f4ebbc1db374b7c (diff) | |
Docs: Add QtQml, QtQuickWidgets and the Qt3D modules
Introduce an inner loop to doc/CMakeLists.txt allowing for
handling qdocconf files that contain several modules.
Task-number: PYSIDE-363
Change-Id: I71839999fe616b56fb3f2bab03bb21f49d0d1dac
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Diffstat (limited to 'sources/pyside2/doc')
| -rw-r--r-- | sources/pyside2/doc/CMakeLists.txt | 34 | ||||
| -rw-r--r-- | sources/pyside2/doc/qtmodules/pyside-qt3dextras.qdocconf.in | 2 | ||||
| -rw-r--r-- | sources/pyside2/doc/qtmodules/pyside-qtquickwidgets.qdocconf.in (renamed from sources/pyside2/doc/qtmodules/pyside-qtquick.qdocconf.in) | 0 |
3 files changed, 24 insertions, 12 deletions
diff --git a/sources/pyside2/doc/CMakeLists.txt b/sources/pyside2/doc/CMakeLists.txt index e364437a2..326e5ae7d 100644 --- a/sources/pyside2/doc/CMakeLists.txt +++ b/sources/pyside2/doc/CMakeLists.txt @@ -29,23 +29,33 @@ set(QDOC_INCPATH -I "${QT_INCLUDE_DIR}" -I "${mkspecInclude}") file(READ "${pyside2_BINARY_DIR}/pyside2_global.h" docHeaderContents) file(READ "typesystem_doc.xml.in" typeSystemDocXmlContents) -foreach(module ${all_module_shortnames}) - string(TOLOWER "${module}" lowerModule) - set(docConf "${CMAKE_CURRENT_LIST_DIR}/qtmodules/pyside-qt${lowerModule}.qdocconf.in") +foreach(moduleIn ${all_module_shortnames}) + string(TOLOWER "${moduleIn}" lowerModuleIn) + set(docConf "${CMAKE_CURRENT_LIST_DIR}/qtmodules/pyside-qt${lowerModuleIn}.qdocconf.in") if(EXISTS "${docConf}") string(REGEX REPLACE "(^.*)\.in" "\\1" OUTFILE ${docConf}) get_filename_component(BASENAME ${OUTFILE} NAME) configure_file(${docConf} "${CMAKE_CURRENT_LIST_DIR}/qtmodules/${BASENAME}" @ONLY) file(APPEND "pyside.qdocconf.in" "\@CMAKE_CURRENT_LIST_DIR\@/qtmodules/${BASENAME}\n") - - # -- @TODO fix this for macOS frameworks. - list(APPEND QDOC_INCPATH - -I "${QT_INCLUDE_DIR}Qt${module}" - -I "${QT_INCLUDE_DIR}Qt${module}/${Qt5Core_VERSION}" - -I "${QT_INCLUDE_DIR}Qt${module}/${Qt5Core_VERSION}/Qt${module}") - - set(docHeaderContents "${docHeaderContents}\n#include <Qt${module}/Qt${module}>") - set(typeSystemDocXmlContents "${typeSystemDocXmlContents}\n<load-typesystem name=\"Qt${module}/typesystem_${lowerModule}.xml\" generate=\"yes\"/>") + # Handle docconf files in Qt that contain multiple modules + if ("${moduleIn}" STREQUAL "3DExtras") + set(modules 3DCore 3DRender 3DInput 3DLogic 3DAnimation "${moduleIn}") + elseif ("${moduleIn}" STREQUAL "QuickWidgets") + set(modules Qml Quick "${moduleIn}") + else() + set(modules "${moduleIn}") + endif() + foreach(module ${modules}) + string(TOLOWER "${module}" lowerModule) + # -- @TODO fix this for macOS frameworks. + list(APPEND QDOC_INCPATH + -I "${QT_INCLUDE_DIR}Qt${module}" + -I "${QT_INCLUDE_DIR}Qt${module}/${Qt5Core_VERSION}" + -I "${QT_INCLUDE_DIR}Qt${module}/${Qt5Core_VERSION}/Qt${module}") + + set(docHeaderContents "${docHeaderContents}\n#include <Qt${module}/Qt${module}>") + set(typeSystemDocXmlContents "${typeSystemDocXmlContents}\n<load-typesystem name=\"Qt${module}/typesystem_${lowerModule}.xml\" generate=\"yes\"/>") + endforeach() endif() endforeach() diff --git a/sources/pyside2/doc/qtmodules/pyside-qt3dextras.qdocconf.in b/sources/pyside2/doc/qtmodules/pyside-qt3dextras.qdocconf.in new file mode 100644 index 000000000..5bc4e8c9c --- /dev/null +++ b/sources/pyside2/doc/qtmodules/pyside-qt3dextras.qdocconf.in @@ -0,0 +1,2 @@ +include(@QT_SRC_DIR@/../qt3d/src/doc/qt3d.qdocconf) +include(../pyside-config.qdocconf) diff --git a/sources/pyside2/doc/qtmodules/pyside-qtquick.qdocconf.in b/sources/pyside2/doc/qtmodules/pyside-qtquickwidgets.qdocconf.in index 242dc3c02..242dc3c02 100644 --- a/sources/pyside2/doc/qtmodules/pyside-qtquick.qdocconf.in +++ b/sources/pyside2/doc/qtmodules/pyside-qtquickwidgets.qdocconf.in |