summaryrefslogtreecommitdiffstats
path: root/src/serialport/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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: I16bde5a3c34540c448a10903e4efde69a9d3585c Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Set example install path in documentation configTopi Reinio2014-04-151-0/+2
| | | | | | | | | | | Correct example install path is required for the example manifest file to contain valid paths to the .pro files. Task-number: QTBUG-38359 Change-Id: Ibfe98ed4f3402f2e1534b578d0caecf3676a6f36 Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Laszlo Papp <lpapp@kde.org>
* Skip qt4support when generating documentation.Friedemann Kleint2014-03-251-0/+1
| | | | | | | | | Fix warnings: qtserialport/src/serialport/qt4support/src/qlockfile.cpp:57: warning: Overrides a previous doc qtbase/src/corelib/io/qlockfile.h:53: warning: (The previous doc is here) Change-Id: I75c93fd6dbd9bebfa506b2f606aeb8511a892305 Reviewed-by: Laszlo Papp <lpapp@kde.org>
* Add a new simple and command line async reader exampleLaszlo Papp2013-11-101-0/+0
| | | | | | Change-Id: I4142d187c3ad37d1e7f5219df3d50679a9f35a8e Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Doc: Updated url variable in qdocconf files.Jerome Pasion2013-11-061-1/+1
| | | | | | | | | | | | | In 5.2, the HTML output is in a flatter structure and when they are hosted in qt-project.org/doc, the documentation will be found at http://qt-project.org/doc/qt-$QT_VER The url variable is used by projects outside of Qt 5 which need to link to Qt 5 documentation, such as Qt Creator. Task-number: QTBUG-34584 Change-Id: Ice4793cdedb1d6287ce863221a831526fbb0f0a5 Reviewed-by: Laszlo Papp <lpapp@kde.org>
* Add a new simple and command line async writer exampleLaszlo Papp2013-11-051-0/+0
| | | | | | Change-Id: I8f33126de5c78da9a4a0dbddd16eecde7044f0c5 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/+0
| | | | | | 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/+0
| | | | | | Change-Id: I5d893d18477790def27bfa1fa051d459a8193db5 Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Doc: minor changes to index.qdocv5.2.0-alpha1Nico Vertriest2013-09-251-3/+3
| | | | | | | | | index.qdoc of QtSerialPort Task-number: QTBUG-32173 Change-Id: I0cc4a3fd0b469d344da952dfd1042e431e043a4b Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Merge remote-tracking branch 'origin/stable' into devSergio Ahumada2013-09-181-3/+4
|\ | | | | | | Change-Id: Iac1dd793d34782bc2d208f17654c4962630d0da7
| * Doc: language and standard reviewNico Vertriest2013-09-181-3/+4
| | | | | | | | | | | | | | Task-number: QTBUG-32173 Change-Id: I225bc1e4dfe3c12d3441c86002305c542377cf5d Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Doc: Setting \qtvariable in module page.Jerome Pasion2013-08-021-0/+2
| | | | | | | | | | | | | | | | | | \qtvariable indicates the QT variable needed in .pro files. QDoc will place the QT variable in the class documentation. Change-Id: I22437154f6808f9eba810d0e35ccae59782fc051 Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Martin Smith <martin.smith@digia.com>
* | Doc: Setting navigation variables.Jerome Pasion2013-07-041-0/+3
|/ | | | | | | | | | | | | | -For Qt 5.2, a navigation bar is implemented: b11cb96f282fb1037ad31fbafe279c9a8a8dfeda (qtbase) -The navigation variables point to pages displayed on the navigation bar. This commit follows the pattern in this commit: 200cad26f258a998d3dc8089445d2c6ae9639ab5 (qtbase) Change-Id: I56f61af54c782f3167050b0a9d0699cd86936d52 Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Doc: Updates based on sanity checkv5.1.0-beta1Venugopal Shivashankar2013-05-065-178/+29
| | | | | | | | | | | | | - 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-031-1/+1
| | | | | | | | | | | | | 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>
* doc: Minor changes to qtserialport.qdocconfSergio Ahumada2013-04-162-5/+8
| | | | | | | | | Organizing the file a bit to make it match other qdocconf files. Also, renaming \title Qt Serial Port to match other modules. Change-Id: I65938cad5184ca886765272294ce07d117f77b5a Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Remove the namespace doc as the namespace usage was removedLaszlo Papp2013-04-081-32/+0
| | | | | | | | This file does not have any useful content either, and unlikely to have in a foreseeable future. Change-Id: I36da8a3599f308a42d5809168b0f48dc197df126 Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* doc: Removed the HTML template from the .qdocconf filesSergio Ahumada2013-04-051-1/+0
| | | | | | | qt-module-defaults.qdocconf already contains the HTML template. Change-Id: I831615cdfdb3d4df73393c6b6815fc837bc444d4 Reviewed-by: Laszlo Papp <lpapp@kde.org>
* Fix the missiing "\endcode" and the left-over "playground"Laszlo Papp2013-02-281-4/+4
| | | | | Change-Id: Ic5974762a80cb6486d8350a5de48393081fc472b Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Replace the deprecated commands (\i, \o, \bold) with the new onesLaszlo Papp2013-02-282-25/+25
| | | | | | | | See the following page for details: http://doc-snapshot.qt-project.org/qt5-stable/qdoc/27-qdoc-commands-alphabetical.html Change-Id: I405deea5cf065075907ac7830e92bb064a1c72d0 Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Revamp the documentation not to be broken for "make docs"Laszlo Papp2013-02-286-67/+30
| | | | | Change-Id: Ifce994b10c67eeefaf1791db2399716d6051cea4 Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Refactor the documentation management for the sourceLaszlo Papp2013-02-262-11/+0
| | | | | | | | | | | | | | | | | | | * Other submodules use qtsubmodule.qdocconf instead of submodule.qdocconf * They also use the QMAKE_DOCS variable to set that to the qtsubmodule.qdocconf * They do not have .pri files for the doc folder * They do not use the QT5DOC variable with "indexes" either. It should have been indices with proper English, anyway. * This also eliminates a warning about the "docs" target duplication The docs is not fully complete yet, but the work is in progress. This is the first step. Change-Id: If33073d367fa7971fb57169d498f005766c166a9 Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Added missed images for blocking master/slave examplesDenis Shienkov2013-02-122-0/+0
| | | | | | Change-Id: Ib659bd3310b777af6ca5b8bc49d68c29a1c6717a Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Replace the qhp namespaceLaszlo Papp2013-02-121-2/+2
| | | | | | | | | | | | | | 1) Nokia is a left-over and it should be qt-project 2) It should 510 (5.1) instead 100 which is probably a left-over release version (1.0) 3) It should be qtserialport instead of QtSerialPort in there to be consistent with the rest in the Qt Project. Change-Id: I4ac9e8bb0918f6bc2311b302bb0c6ff54baa5e09 Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Remove the left-over ADDON entry in the qdocconf fileLaszlo Papp2013-02-111-1/+1
| | | | | | Change-Id: I3cb4e7dc355ce841903ce136c03b84e906254d0b Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Remove the QtSerialPort namespace define and hence namespace usageLaszlo Papp2013-02-071-2/+0
| | | | | | | | | | * This is for following the convention in the Qt Project with the rest. * This fixes examples and tests to build now as all of them are broken due to the regression. Change-Id: I3f4d64d97466520aea621da582a64a0d97e32136 Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Doc: Remove the "bla-bla" entries, and make the English nicerLaszlo Papp2013-02-074-24/+51
| | | | | | Change-Id: I5160ee7116827078d6970ff43a606effb4ea2eed Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Fix the license issues to pass the QtQA license testsLaszlo Papp2013-02-065-5/+5
| | | | | | | | | | | The issues were revealed by qtqa/tests/prebuild/license/tst_licenses.pl while trying to put the QtSerialPort under CI. X - Y is an unfortunate workaround, but seems to be necessary for now due to the following change: https://codereview.qt-project.org/#change,14529 Change-Id: I265f1929961705eda9db54386e721f20495c329c Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Use the module name properly for variables and document entriesLaszlo Papp2013-01-272-14/+14
| | | | | | | | | This is hopefully the last (or at least one of those) left-over due to the big refactoring. Change-Id: I283d2efcb13d05ff070c73d7cb7de0b9ac44fa9f Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Fix a few documentations issues (namespace and correct module name usage)Laszlo Papp2013-01-273-5/+5
| | | | | | | | | | * Reflect the namespace documentation to the QtSerialPort change. * Module names should be spelled with whitespaces in the documentation according to the following convention: http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation Change-Id: I504d45140d3f56fda9d4d6cdd272157bac3959d6 Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Change Denis' email address in the copyrights headersLaszlo Papp2013-01-265-5/+5
| | | | | Change-Id: I8c564f68bb32423957f2171e1c76d8a428f16eb3 Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Call the module QtSerialPort instead of QtAddOnSerialPortLaszlo Papp2013-01-264-7/+7
| | | | | | | | Use the QTSERIALPORT as a term for internal variables as well to remain consistent with the freshly chosen module name. Change-Id: Ia780b105649b39a1eca46702466da5bc31ec5af0 Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
* Move the library and example documentations to the right placesLaszlo Papp2013-01-2611-0/+487
Change-Id: Ia04d1f576b90ba705471b290b50f7adc2b13d00f Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-07 04:25:24 +0000