diff options
author | Laszlo Papp <lpapp@kde.org> | 2013-02-07 04:58:36 +0000 |
---|---|---|
committer | Laszlo Papp <lpapp@kde.org> | 2013-02-07 10:04:28 +0100 |
commit | 1d97ab27b96899247692df64ee726545f6d1031b (patch) | |
tree | 79b2e1670bf83306f229ba239c10491ddfa56acf /src/serialport/doc | |
parent | 27966cb75d8a95c4ada1fbd2f5ee19cf66199842 (diff) | |
download | qtserialport-1d97ab27b96899247692df64ee726545f6d1031b.tar.gz |
Doc: Remove the "bla-bla" entries, and make the English nicer
Change-Id: I5160ee7116827078d6970ff43a606effb4ea2eed
Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com>
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Diffstat (limited to 'src/serialport/doc')
-rw-r--r-- | src/serialport/doc/src/build.qdoc | 19 | ||||
-rw-r--r-- | src/serialport/doc/src/getsrc.qdoc | 28 | ||||
-rw-r--r-- | src/serialport/doc/src/index.qdoc | 7 | ||||
-rw-r--r-- | src/serialport/doc/src/intro.qdoc | 21 |
4 files changed, 51 insertions, 24 deletions
diff --git a/src/serialport/doc/src/build.qdoc b/src/serialport/doc/src/build.qdoc index bda04ad..13de5e6 100644 --- a/src/serialport/doc/src/build.qdoc +++ b/src/serialport/doc/src/build.qdoc @@ -33,11 +33,22 @@ \contentspage {Building and usage} {Contents} \nextpage Examples - \section1 Bla-Bla1 + \section1 Building - Bla-Bla-Bla + Make sure that when you build Qt, that you use the -developer-build option, + and do not do a \c{make install} as root. The same branch can be used for + building with Qt4 and Qt5. - \section1 Bla-Bla2 + Instructions for building against Qt4 are fundamentally the same as for + Qt5. See the information provided below what needs to be done after getting + the source by cloning the repository: - Bla-Bla-Bla + \code + $ cd qtserialport + $ qmake + $ make (Unix) or jom/nmake (Windows) + \endcode + + Once having successfully built, the examples can be run to see the intended + functionality provided by the module. */ diff --git a/src/serialport/doc/src/getsrc.qdoc b/src/serialport/doc/src/getsrc.qdoc index 5c6bcf8..d947a38 100644 --- a/src/serialport/doc/src/getsrc.qdoc +++ b/src/serialport/doc/src/getsrc.qdoc @@ -33,11 +33,31 @@ \contentspage {Get source} {Contents} \nextpage Building and usage - \section1 For users + \section1 Users - Bla-Bla-Bla + \code + $ git clone git://gitorious.org/qtplayground/qtserialport.git + \endcode - \section1 For developers + \section1 Developers - Bla-Bla-Bla + Getting a Qt developer account is necessary to contribute to the project, + so that has to be obtained first. Once, that is done, see the following page + for further details about the Git and Gerrit usage: + + \l{http://wiki.qt-project.org/Setting_up_Gerrit}{Setting up Gerrit} + + The following command can be used to clone the project with push access: + + \code + $ git clone ssh://<username>@codereview.qt-project.org:29418/playground/qtserialport.git + \endcode + + If you are in a corporate environment (e.g. behind a firewall) which only + allows Ports 80 (HTTP) and 443 (HTTPS), use the following configuration + instead: + + \code + $ git clone ssh://<username>@codereview.qt-project.org:443/playground/qtserialport.git + \code */ diff --git a/src/serialport/doc/src/index.qdoc b/src/serialport/doc/src/index.qdoc index 66cf1fd..0d78be5 100644 --- a/src/serialport/doc/src/index.qdoc +++ b/src/serialport/doc/src/index.qdoc @@ -30,11 +30,10 @@ \title Qt Serial Port Reference Documentation \page index.html - \brief The Qt Serial Port module provides classes to make serial programming - easier and portable. + \brief The Qt Serial Port module provides classes to make the serial + programming simple and portable. - To include the definitions of the module's classes, use the - following directive: + Use this form to include Qt Serial Port headers: \code #include <QtSerialPort/QtSerialPort> diff --git a/src/serialport/doc/src/intro.qdoc b/src/serialport/doc/src/intro.qdoc index c74c1a6..a1ccf0f 100644 --- a/src/serialport/doc/src/intro.qdoc +++ b/src/serialport/doc/src/intro.qdoc @@ -37,14 +37,11 @@ Qt Serial Port originated from the third-party library \l{http://gitorious.org/qserialdevice/qserialdevice/trees/2.0}{QSerialDevice 2.0}. - \section1 Overviews - - Bla-bla - \section1 Supported platforms - The goal is to implement support for multiple platforms, the current state - of support provided in the table below: + The primary goal is to support as many common platforms as possible. Please + find the information below about the support state for the various + platforms: \table \header @@ -53,27 +50,27 @@ \o Notes \row \o Windows x86/x64 NT based (2K, XP, Vista, 7, 8) - \o Full support. + \o Complete support (Tier 1). \o Support expected for Windows 8, but has not yet been tested. \row \o Windows CE - \o Partially support. + \o Partial support (Not Tier 1). \o Tested only with platforms 5 and 6 by using the emulator. \row \o Symbian - \o Partially support. + \o Partial support, and only for legacy Qt4 (Not Tier 1). \o The implementation is not complete and further support in doubt. \row \o Gnu/Linux - \o Full support. + \o Complete support (Tier 1). \o \row \o Mac OSX - \o Full support. + \o Complete support (Tier 1). \o \row \o Other *nix - \o Full support. + \o Complete support (Tier 1). \o All POSIX-compatible. \endtable |