diff options
| author | Laszlo Papp <lpapp@kde.org> | 2013-01-26 22:57:56 +0000 |
|---|---|---|
| committer | Laszlo Papp <lpapp@kde.org> | 2013-01-27 12:10:50 +0100 |
| commit | 6f5d68fdec2b3b35b995f9ecc2f4844ec4ae9183 (patch) | |
| tree | 78b552a48255ba36c03d53924ff42604fae8d261 /src/serialport/doc | |
| parent | 1389aa2219858b66504a858eafbdb7986af58f14 (diff) | |
Fix a few documentations issues (namespace and correct module name usage)
* 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>
Diffstat (limited to 'src/serialport/doc')
| -rw-r--r-- | src/serialport/doc/src/index.qdoc | 4 | ||||
| -rw-r--r-- | src/serialport/doc/src/intro.qdoc | 2 | ||||
| -rw-r--r-- | src/serialport/doc/src/namespace.qdoc | 4 |
3 files changed, 5 insertions, 5 deletions
diff --git a/src/serialport/doc/src/index.qdoc b/src/serialport/doc/src/index.qdoc index 0f8d2759..ad49586e 100644 --- a/src/serialport/doc/src/index.qdoc +++ b/src/serialport/doc/src/index.qdoc @@ -27,10 +27,10 @@ /*! \module QtSerialPort - \title QtSerialPort Reference Documentation + \title Qt Serial Port Reference Documentation \page index.html - \brief The QtSerialPort module provides classes to make serial programming + \brief The Qt Serial Port module provides classes to make serial programming easier and portable. To include the definitions of the module's classes, use the diff --git a/src/serialport/doc/src/intro.qdoc b/src/serialport/doc/src/intro.qdoc index e549717b..be28b676 100644 --- a/src/serialport/doc/src/intro.qdoc +++ b/src/serialport/doc/src/intro.qdoc @@ -34,7 +34,7 @@ \section1 History - QtSerialPort originated from the third-party library + Qt Serial Port originated from the third-party library \l{http://gitorious.org/qserialdevice/qserialdevice/trees/2.0}{QSerialDevice 2.0}. \section1 Overviews diff --git a/src/serialport/doc/src/namespace.qdoc b/src/serialport/doc/src/namespace.qdoc index 436de121..ff5ec85a 100644 --- a/src/serialport/doc/src/namespace.qdoc +++ b/src/serialport/doc/src/namespace.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \namespace SerialPort - \brief The SerialPort namespace contains miscellaneous identifiers + \namespace QtSerialPort + \brief The QtSerialPort namespace contains miscellaneous identifiers used throughout the SerialPort library. */ |