diff options
author | J-P Nurmi <jpnurmi@qt.io> | 2016-06-29 14:27:54 +0200 |
---|---|---|
committer | J-P Nurmi <jpnurmi@qt.io> | 2016-08-09 15:25:39 +0000 |
commit | 3a07d1b2e102826f13c80361fe5491ec44c173a6 (patch) | |
tree | c9fa599ca1aadf169708f9663086c0db7f10e57e | |
parent | 45de496a54202b41c0c2f7b519cebc0788b82df0 (diff) |
Restructure the docs to separate the experimental labs QML types
Including the experimental Qt Labs Calendar docs to qqc2.qdocconf leads
to Qt Creator's help contents being mixed with QML types from both
modules. Move the Qt Labs Calendar to its own .qdocconf the same way
it's done for Qt Labs Platform, and just link to both from the index
page. This also ensures that the index-search offers "Calendar" from
"Qt Quick Controls (1)" and "Qt Labs Calendar" instead of "Qt Quick
Controls 2".
Change-Id: Iaf5e7df6d3013657c774d65bf76fb7bc2f80aa71
Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
-rw-r--r-- | src/imports/calendar/calendar.pro | 2 | ||||
-rw-r--r-- | src/imports/calendar/doc/images/qtlabscalendar-calendarmodel.png (renamed from src/imports/controls/doc/images/qtlabscalendar-calendarmodel.png) | bin | 5724 -> 5724 bytes | |||
-rw-r--r-- | src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow-layout.png (renamed from src/imports/controls/doc/images/qtlabscalendar-dayofweekrow-layout.png) | bin | 7455 -> 7455 bytes | |||
-rw-r--r-- | src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow.png (renamed from src/imports/controls/doc/images/qtlabscalendar-dayofweekrow.png) | bin | 2017 -> 2017 bytes | |||
-rw-r--r-- | src/imports/calendar/doc/images/qtlabscalendar-monthgrid-layout.png (renamed from src/imports/controls/doc/images/qtlabscalendar-monthgrid-layout.png) | bin | 8876 -> 8876 bytes | |||
-rw-r--r-- | src/imports/calendar/doc/images/qtlabscalendar-monthgrid.png (renamed from src/imports/controls/doc/images/qtlabscalendar-monthgrid.png) | bin | 3827 -> 3827 bytes | |||
-rw-r--r-- | src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn-layout.png (renamed from src/imports/controls/doc/images/qtlabscalendar-weeknumbercolumn-layout.png) | bin | 4986 -> 4986 bytes | |||
-rw-r--r-- | src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn.png (renamed from src/imports/controls/doc/images/qtlabscalendar-weeknumbercolumn.png) | bin | 1453 -> 1453 bytes | |||
-rw-r--r-- | src/imports/calendar/doc/qtlabscalendar.qdocconf | 37 | ||||
-rw-r--r-- | src/imports/calendar/doc/snippets/qtlabscalendar-calendarmodel.qml (renamed from src/imports/controls/doc/snippets/qtlabscalendar-calendarmodel.qml) | 0 | ||||
-rw-r--r-- | src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow-layout.qml (renamed from src/imports/controls/doc/snippets/qtlabscalendar-dayofweekrow-layout.qml) | 0 | ||||
-rw-r--r-- | src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow.qml (renamed from src/imports/controls/doc/snippets/qtlabscalendar-dayofweekrow.qml) | 0 | ||||
-rw-r--r-- | src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid-layout.qml (renamed from src/imports/controls/doc/snippets/qtlabscalendar-monthgrid-layout.qml) | 0 | ||||
-rw-r--r-- | src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid.qml (renamed from src/imports/controls/doc/snippets/qtlabscalendar-monthgrid.qml) | 0 | ||||
-rw-r--r-- | src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn-layout.qml (renamed from src/imports/controls/doc/snippets/qtlabscalendar-weeknumbercolumn-layout.qml) | 0 | ||||
-rw-r--r-- | src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn.qml (renamed from src/imports/controls/doc/snippets/qtlabscalendar-weeknumbercolumn.qml) | 0 | ||||
-rw-r--r-- | src/imports/controls/doc/qtquickcontrols2.qdocconf | 9 | ||||
-rw-r--r-- | src/imports/controls/doc/src/qtquickcontrols2-index.qdoc | 1 |
18 files changed, 42 insertions, 7 deletions
diff --git a/src/imports/calendar/calendar.pro b/src/imports/calendar/calendar.pro index 8e9446cc..981860b5 100644 --- a/src/imports/calendar/calendar.pro +++ b/src/imports/calendar/calendar.pro @@ -7,6 +7,8 @@ QT_PRIVATE += core-private gui-private qml-private quick-private quicktemplates2 DEFINES += QT_NO_CAST_TO_ASCII QT_NO_CAST_FROM_ASCII +QMAKE_DOCS = $$PWD/doc/qtlabscalendar.qdocconf + OTHER_FILES += \ qmldir diff --git a/src/imports/controls/doc/images/qtlabscalendar-calendarmodel.png b/src/imports/calendar/doc/images/qtlabscalendar-calendarmodel.png Binary files differindex 7a140d27..7a140d27 100644 --- a/src/imports/controls/doc/images/qtlabscalendar-calendarmodel.png +++ b/src/imports/calendar/doc/images/qtlabscalendar-calendarmodel.png diff --git a/src/imports/controls/doc/images/qtlabscalendar-dayofweekrow-layout.png b/src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow-layout.png Binary files differindex 130e3757..130e3757 100644 --- a/src/imports/controls/doc/images/qtlabscalendar-dayofweekrow-layout.png +++ b/src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow-layout.png diff --git a/src/imports/controls/doc/images/qtlabscalendar-dayofweekrow.png b/src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow.png Binary files differindex 6c8424ab..6c8424ab 100644 --- a/src/imports/controls/doc/images/qtlabscalendar-dayofweekrow.png +++ b/src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow.png diff --git a/src/imports/controls/doc/images/qtlabscalendar-monthgrid-layout.png b/src/imports/calendar/doc/images/qtlabscalendar-monthgrid-layout.png Binary files differindex dd903650..dd903650 100644 --- a/src/imports/controls/doc/images/qtlabscalendar-monthgrid-layout.png +++ b/src/imports/calendar/doc/images/qtlabscalendar-monthgrid-layout.png diff --git a/src/imports/controls/doc/images/qtlabscalendar-monthgrid.png b/src/imports/calendar/doc/images/qtlabscalendar-monthgrid.png Binary files differindex 0c3b3c41..0c3b3c41 100644 --- a/src/imports/controls/doc/images/qtlabscalendar-monthgrid.png +++ b/src/imports/calendar/doc/images/qtlabscalendar-monthgrid.png diff --git a/src/imports/controls/doc/images/qtlabscalendar-weeknumbercolumn-layout.png b/src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn-layout.png Binary files differindex b015a3e6..b015a3e6 100644 --- a/src/imports/controls/doc/images/qtlabscalendar-weeknumbercolumn-layout.png +++ b/src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn-layout.png diff --git a/src/imports/controls/doc/images/qtlabscalendar-weeknumbercolumn.png b/src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn.png Binary files differindex 65e25b29..65e25b29 100644 --- a/src/imports/controls/doc/images/qtlabscalendar-weeknumbercolumn.png +++ b/src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn.png diff --git a/src/imports/calendar/doc/qtlabscalendar.qdocconf b/src/imports/calendar/doc/qtlabscalendar.qdocconf new file mode 100644 index 00000000..0e230aa1 --- /dev/null +++ b/src/imports/calendar/doc/qtlabscalendar.qdocconf @@ -0,0 +1,37 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) + +project = QtLabsCalendar +description = Qt Labs Calendar Reference Documentation +version = $QT_VERSION + +qhp.projects = QtLabsCalendar + +qhp.QtLabsCalendar.file = qtlabscalendar.qhp +qhp.QtLabsCalendar.namespace = org.qt-project.qtlabscalendar.$QT_VERSION_TAG +qhp.QtLabsCalendar.virtualFolder = qtlabscalendar +qhp.QtLabsCalendar.indexTitle = Qt Labs Calendar +qhp.QtLabsCalendar.indexRoot = + +qhp.QtLabsCalendar.filterAttributes = qtlabscalendar $QT_VERSION qtrefdoc +qhp.QtLabsCalendar.customFilters.Qt.name = QtLabsCalendar $QT_VERSION +qhp.QtLabsCalendar.customFilters.Qt.filterAttributes = qtlabscalendar $QT_VERSION + +qhp.QtLabsCalendar.subprojects = qmltypes +qhp.QtLabsCalendar.subprojects.qmltypes.title = QML Types +qhp.QtLabsCalendar.subprojects.qmltypes.indexTitle = Qt Labs Calendar QML Types +qhp.QtLabsCalendar.subprojects.qmltypes.selectors = qmlclass +qhp.QtLabsCalendar.subprojects.qmltypes.sortPages = true + +depends = qtcore qtgui qtdoc qtqml qtquick qtquickcontrols2 + +headerdirs += ../ +sourcedirs += ../ src +exampledirs += ../ snippets +imagedirs += images + +navigation.landingpage = "Qt Labs Calendar" +navigation.qmltypespage = "Qt Labs Calendar QML Types" + +tagfile = qtlabscalendar.tags + +macro.labs = "\\note \\e{Types in Qt.labs modules are not guaranteed to remain compatible in future versions.}" diff --git a/src/imports/controls/doc/snippets/qtlabscalendar-calendarmodel.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-calendarmodel.qml index 37a6ced7..37a6ced7 100644 --- a/src/imports/controls/doc/snippets/qtlabscalendar-calendarmodel.qml +++ b/src/imports/calendar/doc/snippets/qtlabscalendar-calendarmodel.qml diff --git a/src/imports/controls/doc/snippets/qtlabscalendar-dayofweekrow-layout.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow-layout.qml index ce41d224..ce41d224 100644 --- a/src/imports/controls/doc/snippets/qtlabscalendar-dayofweekrow-layout.qml +++ b/src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow-layout.qml diff --git a/src/imports/controls/doc/snippets/qtlabscalendar-dayofweekrow.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow.qml index 5ea3714c..5ea3714c 100644 --- a/src/imports/controls/doc/snippets/qtlabscalendar-dayofweekrow.qml +++ b/src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow.qml diff --git a/src/imports/controls/doc/snippets/qtlabscalendar-monthgrid-layout.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid-layout.qml index 346e6099..346e6099 100644 --- a/src/imports/controls/doc/snippets/qtlabscalendar-monthgrid-layout.qml +++ b/src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid-layout.qml diff --git a/src/imports/controls/doc/snippets/qtlabscalendar-monthgrid.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid.qml index 16f872b8..16f872b8 100644 --- a/src/imports/controls/doc/snippets/qtlabscalendar-monthgrid.qml +++ b/src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid.qml diff --git a/src/imports/controls/doc/snippets/qtlabscalendar-weeknumbercolumn-layout.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn-layout.qml index d105553f..d105553f 100644 --- a/src/imports/controls/doc/snippets/qtlabscalendar-weeknumbercolumn-layout.qml +++ b/src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn-layout.qml diff --git a/src/imports/controls/doc/snippets/qtlabscalendar-weeknumbercolumn.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn.qml index e58e5c7b..e58e5c7b 100644 --- a/src/imports/controls/doc/snippets/qtlabscalendar-weeknumbercolumn.qml +++ b/src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn.qml diff --git a/src/imports/controls/doc/qtquickcontrols2.qdocconf b/src/imports/controls/doc/qtquickcontrols2.qdocconf index 73f9bdfc..a01b48e5 100644 --- a/src/imports/controls/doc/qtquickcontrols2.qdocconf +++ b/src/imports/controls/doc/qtquickcontrols2.qdocconf @@ -29,7 +29,7 @@ qhp.QtQuickControls2.subprojects.examples.title = Examples qhp.QtQuickControls2.subprojects.examples.indexTitle = Qt Quick Controls 2 Examples qhp.QtQuickControls2.subprojects.examples.selectors = fake:example -depends = qtcore qtgui qtdoc qtqml qtquick qtquickdialogs qtquickcontrols qtquickextras qmake qtsql qtwidgets +depends = qtcore qtgui qtdoc qtqml qtquick qtquickdialogs qtquickcontrols qtquickextras qmake qtsql qtwidgets qtlabscalendar qtlabsplatform # Specify the install path under QT_INSTALL_EXAMPLES # Note: paths passed to \example command must contain the parent directory, e.g. @@ -37,20 +37,16 @@ depends = qtcore qtgui qtdoc qtqml qtquick qtquickdialogs qtquickcontrols qtquic exampledirs += ../../../../examples/quickcontrols2 \ ../ \ ../../../quicktemplates2 \ - ../../calendar \ snippets examplesinstallpath = quickcontrols2 headerdirs += ../../../quicktemplates2 \ - ../../../quickcontrols2 \ - ../../calendar + ../../../quickcontrols2 sourcedirs += ../../../quicktemplates2 \ ../../../quickcontrols2 \ ../../templates/doc/src \ - ../../calendar/doc/src \ - ../../calendar \ src imagedirs += images @@ -84,7 +80,6 @@ macro.endstylemethod = "\\br" macro.stylecolor.HTML = "<div style=\"padding:10px;color:#fff;background:\1;\">\1 \2</div>" macro.nbsp.HTML = " " -macro.labs = "\\note \\e{Types in Qt.labs modules are not guaranteed to remain compatible in future versions.}" #Add output suffix to the html filenames outputsuffixes = QML diff --git a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc index a021805a..1155032b 100644 --- a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc +++ b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc @@ -92,5 +92,6 @@ \li \l{Qt Quick Layouts} \li \l{Qt Quick Templates 2} \li \l{Qt Labs Calendar} + \li \l{Qt Labs Platform} \endlist */ |