Details
-
Bug
-
Resolution: Done
-
P2: Important
-
None
-
5.0.0
-
None
Description
Qt WebKit has no documentation.
This page: http://doc-snapshot.qt-project.org/5.0/modules.html
clicking on "Qt WebKit" should go to the landing page.
WebKit needs:
-landing page
-examples page
-reference page (using \qmlmodule and \module)
WebKit also needs to be in the standard documentation build ('make docs).
for more information: http://qt-project.org/wiki/Qt5DocumentationProject
=================================
Additional issues:
-Qt WebKit and Qt WebKit Widgets.
Both need their own qdocconf file so that we get two directories: $QT_INSTALL_DOCS/qtwebkit and $QT_INSTALL_DOCS/qtwebkitwidgets
Each needs to have their own landing pages, C++ classes page, QML types page, and other pages.
-Sort out WebKit examples.
There is a qtwebkit-examples-and-demos repository which needs to have a separate qdocconf file so then QDoc can link to the examples using the titles. If the repo will not have a qdocconf file, then we need to move the examples (code + docs) either to qtdoc or Qt WebKit repository.
A new qdocconf file will mean:
-three Qt WebKit .qch and output dir related files. (index and qhp files too)
-the qtwebkit-examples-and-demos need to build the documentation through the "make docs" target.
-Make sure Qt Creator can load the qch and the examples-manifest files. There is no qtwebkit/examples-manifest.xml file.
Attachments
Issue Links
- is required for
-
QTBUG-27513 Create or polish reference pages
- Closed
- relates to
-
QTBUG-28418 Webkit examples are not available under Qt Creator / examples page
- Closed
For Gerrit Dashboard: QTBUG-27646 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
42757,1 | Doc: Fixing Qt WebKit reference documentation. | stable | qt/qtwebkit | Status: MERGED | +2 | 0 |
42758,1 | Doc: Removed hyphen from the names. | stable | qt/qtwebkit-examples | Status: MERGED | +2 | 0 |
42834,1 | Doc: Removed hyphen from the names. | release | qt/qtwebkit-examples | Status: MERGED | +2 | 0 |
42856,1 | Doc: Fixing Qt WebKit reference documentation. | release | qt/qtwebkit | Status: MERGED | +2 | 0 |