summaryrefslogtreecommitdiffstats
path: root/examples/serialport/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Fix documentation warningsTopi Reinio2019-11-111-1/+1
| | | | | | | | | | | | | | The header file for QWinOverlappedIoNotifier is not available when building on non-Windows platform - as the class is \internal anyway, suppress the Clang-parser warnings by marking also the member functions as \internal. Remove a link to example file page terminal/console.cpp, as QDoc no longer treats these files as linkable targets. Fixes: QTBUG-79809 Change-Id: Ic3bc33c1c27bc234513fe6977877116ed16c22eb Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix links to example codeNico Vertriest2019-08-271-19/+16
| | | | | | | | - Qdoc doesn't create links to example code anymore - modifying references to example code Change-Id: I7e526b8767f20958b00974c46c3e174ab12d5663 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Unify license header usageAntti Kokko2016-02-029-45/+45
| | | | | | | | Updated FDL license. Change-Id: I1165e025a7f9f3628d0bc25553b48d27384413ca Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Jani Heikkinen <jani.heikkinen@theqtcompany.com>
* Doc: minor link issueNico Vertriest2015-10-131-2/+2
| | | | | | Change-Id: I3dc7dcd60e66b36f0e9913760e80df798e52da80 Task-number: QTBUG-43810 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Merge remote-tracking branch 'origin/5.4' into 5.5Frederik Gladhorn2015-02-251-1/+1
|\ | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf src/serialport/qserialport_unix.cpp src/serialport/qserialport_unix_p.h src/serialport/qserialport_win.cpp src/serialport/qserialport_win_p.h src/serialport/qserialport_wince.cpp src/serialport/qserialport_wince_p.h Change-Id: Ibb917652b132e66fbb90f437bf762c1094911dc0
| * Doc: Fix the examples pageTopi Reinio2015-01-201-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The group page listing all the examples defined also a \page name, which caused the generated page to contain no examples. Also correct the group name for Command Line Enumerator Example, and move the qtserialport-examples.qdoc to the correct location. Change-Id: I6ebfbe1c49d2a44e4ed631f22027659ba43ceb8d Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com> Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* | Update copyright headersJani Heikkinen2015-02-139-54/+54
|/ | | | | | | | | | 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: I35f551de8408a2eb6a0f39df1f09d90c8084a7c0 Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Doc: Edited example documentation.Jerome Pasion2014-07-149-34/+65
| | | | | | | | | | | | | -added information about how to run the example by including a file from qtbase/doc/global -edited summary sections -added \brief. -removed image captions. Our Qt 5 CSS files don't handle them. Task-number: QTBUG-33597 Change-Id: If3293aa9d98b662f20af2af7030b0ab0fb1e8401 Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Merge remote-tracking branch 'origin/release' into stableFrederik Gladhorn2014-02-111-1/+1
|\ | | | | | | | | | | | | Conflicts: src/serialport/qserialport_win.cpp Change-Id: Ib00a645c6660a3c81dbc9e159110f7bfc392ea36
| * Fix the creaderasync example name in the qdoc fileLaszlo Papp2014-01-241-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This change eliminates the following warnings when using "make docs": /home/lpapp/Projects/qt/qt5/qtserialport/examples/serialport/doc/creaderasync.qdoc:28: warning: Cannot find file 'creader/creader.pro' or 'creader/creader.qmlproject' /home/lpapp/Projects/qt/qt5/qtserialport/examples/serialport/doc/creaderasync.qdoc:28: warning: EXAMPLE PATH DOES NOT EXIST: creader It is also visible that the example is unreachable on the following documentation page: http://qt-project.org/doc/qt-5/examples.html Change-Id: I09f1532fcff6b1f7bfc5c4857bd14252aceb2eb3 Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com> Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com>
* | Fix some typos in documentation.Jeff Tranter2014-01-302-2/+2
|/ | | | | | | Fix some spelling and grammatical errors in comments that show up in Qt documentation. No changes to code. Change-Id: I185458e162d115eac25326d239b851b5e14ed5cf Reviewed-by: Laszlo Papp <lpapp@kde.org>
* Add a new simple and command line async reader exampleLaszlo Papp2013-11-101-0/+45
| | | | | | Change-Id: I4142d187c3ad37d1e7f5219df3d50679a9f35a8e Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Add a new simple and command line async writer exampleLaszlo Papp2013-11-051-0/+46
| | | | | | Change-Id: I8f33126de5c78da9a4a0dbddd16eecde7044f0c5 Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Fix the broken example qdoc keyword valueLaszlo Papp2013-10-281-1/+1
| | | | | | | | | | | | | | | | | | | | | The "cwritersync" example has been introduced in commit 9f8f2d6dc6f38b54a91f4a3d7ebf4285891005d3, and the "creadersync" example has been introduced in commit ccdf42d9d10a32ccdd4a12c643130ffdea498552. Initially, the "cwritersync" example was called "cwriter", but then it got renamed to reflect the functionality more explicitly based on its name. Having that renaming done, I had to sync up the writer and reader terms everywhere, but this instance has been accidentally left out. It is not intentional to have this name, so this is a bug. This is a somewhat critical bugfix because it may trigger the example unavailable from the main example page. Thereby, a useful example could become useless for the end users. Change-Id: I0f483ea037fc76a362f1d174b521075e8e9b0a3a Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Add a new simple and command line reader exampleLaszlo Papp2013-10-251-0/+45
| | | | | | Change-Id: I69c05be5db564888986925d943aff32221f5b310 Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Add a new simple and command line writer exampleLaszlo Papp2013-10-251-0/+45
| | | | | | Change-Id: I5d893d18477790def27bfa1fa051d459a8193db5 Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Refactor the blocking master documentationLaszlo Papp2013-10-011-66/+69
| | | | | Change-Id: I67e1eb66c5661f6830389189a323aa7f97e474f9 Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Doc: Review QtSerialPort documentationNico Vertriest2013-09-272-69/+67
| | | | | | | | | | Adapted to review comments Task-number: QTBUG-32173 Change-Id: I41839934c3aea9ccf3ef596e2a869b479f3c75ba Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Updates based on sanity checkv5.1.0-beta1Venugopal Shivashankar2013-05-063-20/+23
| | | | | | | | | | | | | - Removed redundant qdoc pages on supported platforms, getting source, and building from source. - Added a module page to list the C++ classes - Removed unnecessary \module commands in several pages - Made a few language edits to class documentation - Updated the index page with some introductory content - Fixed broken links to the examples Change-Id: Ia7bd74b383f344426814db736f7bc4cd77c13992 Reviewed-by: Laszlo Papp <lpapp@kde.org>
* Fix examples directory layoutKai Koehne2013-05-035-0/+558
Move examples into a dedicated 'serialport' directory. This is in line with what the other modules do, and makes sure that the examples show up in a sensible place even for the 'combined' source packages. Task-number: QTBUG-30912 Change-Id: Iefa2b634df3d2eb34f655b34f6fb24a224b78869 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com> Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-15 00:51:41 +0000