summaryrefslogtreecommitdiff
path: root/src/websockets/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: fix missing closing commentAndre Hartmann2020-02-241-0/+1
| | | | | Change-Id: I2e1f4893b1b4c1270630101c390b937611e5d5e2 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: fix links to autobahn testsuiteAndre Hartmann2020-02-241-2/+2
| | | | | | Fixes: QTBUG-69425 Change-Id: I28e03da927c7a9b1cbfb91a0aca32866c2e653ea Reviewed-by: Christian Ehrlicher <ch.ehrlicher@gmx.de>
* Doc: Replace example file lists with links to code.qt.ioTopi Reinio2019-07-091-0/+1
| | | | | | Task-number: QTBUG-74391 Change-Id: I4f5a70c7439b27db2b02907e460b5804d5c6e104 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Automatically register the latest import versionv5.13.0-beta3Kai Koehne2019-04-122-7/+7
| | | | | | | | | | | | | This follows what was done in d28c9f6a for Qt Quick Controls 2. The latest import version (e.g. 1.14 in Qt 5.14) will automatically be registered whenever the Qt version is bumped. This avoids needing to wait until a new type is added (or a new revision is added to an existing type) before being able to use the newest Qt Quick version. Change-Id: I3a2232d5f7418ec99441a71fb70d88835dc61a61 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Add license section to overviewv5.11.0-beta4Kai Koehne2018-04-051-0/+9
| | | | | | Change-Id: I580d2170f76a501dd95c8377d3f480b65a983d53 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Fix outdated FDL license headerKai Koehne2017-10-235-22/+22
| | | | | Change-Id: Ic41f3745e800ba54153b36f269017075297c2402 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* Merge remote-tracking branch 'origin/5.7' into 5.8Liang Qi2016-11-261-1/+1
|\ | | | | | | Change-Id: Ia8c2930d5bf681227cef0730cdf0dca6d068722f
| * Doc: Add verb to WebSockets introv5.6.25.6.2Kai Koehne2016-08-121-1/+1
| | | | | | | | | | Change-Id: I4c9f3a50c24f945c0f14010a10ff808d8adf7845 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Merge remote-tracking branch 'origin/5.7' into devLiang Qi2016-08-021-4/+10
|\ \ | |/ | | | | | | | | | | Conflicts: .qmake.conf Change-Id: I593c47e7aeebb7997f42a7408a8d22704d2713a1
| * Doc: Also mention QML Import in index pageKai Koehne2016-05-231-4/+10
| | | | | | | | | | | | | | qtwebsockets-index.html is the entry point for both C++ and QML API. Change-Id: I81efb2d7b931cce0d63efc2f25ce89904abcbfad Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Doc: Update WebSockets import to 1.1Kai Koehne2016-05-261-2/+2
|/ | | | | Change-Id: Ied0b921fb5bc666f0cec7c722880f1c91e1c6923 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Remove repository name from examplesinstallpathv5.6.1-1v5.6.15.6.1Topi Reinio2016-05-121-1/+1
| | | | | | | | Examples in binary packages now directly match the install path. Change-Id: Id4e9b2bc738ae3b1b35114c74530aa50e4103aa3 Task-number: QTBUG-52953 Reviewed-by: Antti Kokko <antti.kokko@qt.io>
* Doc: Avoid auto-linking of WebSocket, WebSocketsKai Koehne2016-04-071-0/+20
| | | | | | | | | | | | Disable the automatic linking of 'WebSocket' to the QML type, and 'WebSockets' to a section in the general documentation. Instead, make the linking explicit where it makes sense. This patch is inspired by 0228a5bd581ae6d672ce5f3 in qtwebengine. Change-Id: I80886360d5f7fdaa68a5e5f6fa982137c7187719 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: Add external-resources.qdocKai Koehne2016-04-073-5/+111
| | | | | | | | | Also sanitize some linking, e.g. by referencing to the paper by title, not by link. Change-Id: I95482994ca569001a23a3beb0e3cbe6739f4ed77 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: Remove reference to Qt Cloud servicev5.6.0-rc1v5.6.05.6.0Venugopal Shivashankar2016-02-151-10/+9
| | | | | | Task-number: QTBUG-51087 Change-Id: I98190d1981c864ee3fc5dc6d7e5375527536adfd Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: Update examplesinstallpath to include the repository nameTopi Reinio2015-10-151-1/+1
| | | | | | | | | | | | The examplesinstallpath variable in .qdocconf files defines the path under QT_INSTALL_EXAMPLES where examples are found. To match the way examples are packaged in Qt 5.6, prefix the install path with the repository name. Task-number: QTBUG-48736 Change-Id: I24d946bad60ef0c9e81517979abfa6e3969df0cb Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Merge remote-tracking branch 'origin/5.4' into 5.5Liang Qi2015-08-191-1/+5
|\ | | | | | | | | | | | | Conflicts: .qmake.conf Change-Id: I3f9a7c0afccb925e1b821ca7191dab4e1855cc21
| * Doc: Updated the list of examples that need generic thumbnail image5.4Venugopal Shivashankar2015-05-291-1/+5
| | | | | | | | | | | | | | | | | | | | One of the example documentation has an image so the list must be more specific. Task-number: QTBUG-41996 Change-Id: I785dad33f227a7e51daf61540f402e67b6609cc7 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* | Doc: Added an overview page and updated the qdocconfVenugopal Shivashankar2015-06-244-6/+118
| | | | | | | | | | | | Task-number: QTBUG-41044 Change-Id: I074573e814de63e009744a11054365fb2f25bdb9 Reviewed-by: Liang Qi <liang.qi@theqtcompany.com>
* | Doc: Add documentation on how to test with Autobahn|TestsuiteLiang Qi2015-06-032-2/+21
| | | | | | | | | | | | Change-Id: Ia18acdc3c54e2bb48209406d2a6f9e156b67324c Reviewed-by: Liang Qi <liang.qi@theqtcompany.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* | Doc: Document the changes to the QML import statementSze Howe Koh2015-05-221-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | The changes happened in 759b6b12489b68fcbd755398ff9337acefb035a0 [ChangeLog][QML] The import statement has changed from "import Qt.WebSockets 1.0" to "import QtWebSockets 1.0". The old statement is still supported, but it cannot be mixed with the new statement within the same project. Change-Id: I95d75e4a87133c452d2ea43c42593415de882c9b Reviewed-by: Liang Qi <liang.qi@theqtcompany.com> Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
* | Doc: Added introductory text about WebSocketVenugopal Shivashankar2015-02-252-6/+12
| | | | | | | | | | | | | | | | | | Also removed an unnecessary \annotatedlist entry in the QML module page. Change-Id: I1af566d3cc784766b4df474e2471e0885ab5e471 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* | Merge "Merge remote-tracking branch 'origin/5.4' into 5.5" into refs/staging/5.5Frederik Gladhorn2015-02-241-1/+5
|\ \
| * \ Merge remote-tracking branch 'origin/5.4' into 5.5Frederik Gladhorn2015-02-201-1/+5
| |\ \ | | |/ | | | | | | Change-Id: I96657102802860c8490c162462324e661592d879
| | * Doc: added qmake to dependenciesNico Vertriest2015-02-161-1/+1
| | | | | | | | | | | | | | | | | | | | | Change-Id: Ib38445f8bf67e3bfe81f5d2d1a30f7b429f30ac5 Task-number: QTBUG-43810 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
| | * Doc: add description and image for echoclient htmlLiang Qi2015-02-131-0/+4
| | | | | | | | | | | | | | | Change-Id: I7e2adaf19d15842f914be6f946f30d09b7b5532f Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* | | Update copyright headersJani Heikkinen2015-02-163-15/+15
|/ / | | | | | | | | | | | | | | | | | | Qt copyrights are now in The Qt Company, so we could update the source code headers accordingly. In the same go we should also fix the links to point to qt.io. Change-Id: I8467410bfad44e8d3fe6bd5724c61bb0c07c91f9 Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com> Reviewed-by: Sergio Ahumada <sahumada@texla.cl>
* | Rename QML import from "Qt.WebSockets" to "QtWebSockets"Sze Howe Koh2014-12-011-2/+2
|/ | | | | | | | | | | This is in line with all other modules (e.g. "QtWebEngine 1.x", "QtQuick 2.x", "QtWebKit 3.x", "QtSensors 5.x") The old name is retained for compatibility with code from Qt 5.3. This is achieved by having a dummy qmldir file in the old location. Change-Id: I66576abe5edb44c3338c47b2980f34574129af01 Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
* Improve the integration of QtWebsockets into general Qt docsv5.4.0-beta1Alex Blasche2014-09-281-3/+4
| | | | | | | | | | | | | 1.) The websocket qml types page is now hooked into Qt's QML Type by Module page. 2.) Correct incorrectly documented import statement for Qt.WebSockets module in QML. 3.) Add missing \since tags (see QTBUG-36775). Change-Id: I1321db70215fcd16cfbd77dd71a459244241d8a3 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Removing url variable from qdocconf file.Jerome Pasion2014-07-071-1/+0
| | | | | | | -url inherited from the url variable set in qtbase/doc/global Change-Id: I55312f10a949dc75fdfbf644631fc844afc29329 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Fix qmlclass selector used in documentation configTopi Reinio2014-06-111-1/+1
| | | | | | | | | | A recent change (46959875) in qdoc raised QML types from subnodes to top-level nodes. This change modifies the documentation configuration file(s) accordingly. Change-Id: I558f00483b4f2efaa12c94066e309f46ea6e9b42 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Fix example path in documentation configv5.3.0-beta1Topi Reinio2014-03-211-1/+1
| | | | | | Task-number: QTBUG-37643 Change-Id: Ifce8f4016c70642a7ae344b0bab463eb201460df Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
* Doc: small fix in documentationKurt Pattyn2014-03-191-1/+1
| | | | | Change-Id: If7c0e3f33c8c73695492511ff51ab58f4a7863d0 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Language/writ. guidelines review Qt WebSocketsNico Vertriest2014-03-141-2/+1
| | | | | | | Task-number: QTBUG-37149 Change-Id: Ic0c28928404fc515de40e6fdff11849cdb2929d6 Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Add generic thumbnails for the examplesTopi Reinio2014-03-141-0/+2
| | | | | | | | | | | | As the examples do not have any images in their documentation, no thumbnails are generated. This change adds generic 'Qt Code Sample' thumbnails for the examples, ensuring that they are listed in Qt Creator's example list. Change-Id: I40d3c69e9cebad72997d82eba0758c63c146aea7 Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
* Doc: Review documentation Qt WebSocketsNico Vertriest2014-03-112-2/+13
| | | | | | | Task-number: QTBUG-37149 Change-Id: Ia8fe7b11140d31bc231a17bfcc16887f3af0dbce Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fixed missing line separators in qdocconf file.v5.3.0-alpha1Jerome Pasion2014-02-241-2/+2
| | | | | | | | | -needed to get the documentation to build. Task-number: QTBUG-33360 Change-Id: Ifed61ebb39843936ac3e350f26f6accffda78318 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
* Re-enable QML componentKurt Pattyn2014-02-113-10/+9
| | | | | | | Change-Id: I84948cf414585af841f3e669ddaf18b7a10fb22f Reviewed-by: Milian Wolff <milian.wolff@kdab.com> Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com> Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Comment out QML componentKurt Pattyn2014-02-043-14/+12
| | | | | | | | Commented out QWebSocket QML component because there is still discussion regarding its API. Change-Id: I9a0699e19186f7e9761517fd127ac8a5263c745f Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
* Bump module version to 5.3.0Kurt Pattyn2014-01-201-1/+1
| | | | | Change-Id: I93120dafc1457de8b24774a81a4303d71974063e Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
* Use QStringLiteral where appropriateKurt Pattyn2014-01-201-1/+1
| | | | | Change-Id: I608b555428aceafd7761a882cd4bd1fdb50d19b3 Reviewed-by: Richard J. Moore <rich@kde.org>
* Cleanup documentationKurt Pattyn2014-01-201-1/+2
| | | | | | | Limited line length to 100 characters Change-Id: Id51c72cb4e7091478bdb57b45514e89f3a6565dd Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
* Link qml documentation and make it visible in creatorFrederik Gladhorn2014-01-113-5/+14
| | | | | Change-Id: I39cd6aab1eb7dd154bc41a211984396540b6979c Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
* Fix typoFrederik Gladhorn2014-01-111-1/+1
| | | | | Change-Id: Ie7a6724b6075ed50f30072e637780234ee7fe48c Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
* Add Qml documentationKurt Pattyn2013-12-271-3/+13
| | | | | Change-Id: I38bfb0d87614fee1d508567a014a41e4be8cf6c2 Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
* Fix the documentation by using the qdocconf term aroundLaszlo Papp2013-12-221-0/+0
| | | | | Change-Id: I8a999c27b71e23d5090d45c900ad3c3492e43668 Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
* Add extra documentationKurt Pattyn2013-12-222-3/+19
| | | | | Change-Id: I1a3c0571faeabf2d05bc144628d186e5ff039014 Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
* Refine doc generationKurt Pattyn2013-11-016-31/+173
| | | | | Change-Id: I9da90086c63b88a5664f241da2fa9687c3882ddf Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
* Replaced tabs by spacesKurt Pattyn2013-10-051-15/+15
| | | | | Change-Id: If12cafe55ac10d312228840cdce08818485594bd Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
* Changed module name to QtWebSocketsKurt Pattyn2013-10-051-3/+3
| | | | | Change-Id: Ib404634017129c3639c1e96685306e333ad73686 Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>