From 6f5d68fdec2b3b35b995f9ecc2f4844ec4ae9183 Mon Sep 17 00:00:00 2001 From: Laszlo Papp Date: Sat, 26 Jan 2013 22:57:56 +0000 Subject: 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 --- src/serialport/doc/src/index.qdoc | 4 ++-- src/serialport/doc/src/intro.qdoc | 2 +- src/serialport/doc/src/namespace.qdoc | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) (limited to 'src/serialport/doc') diff --git a/src/serialport/doc/src/index.qdoc b/src/serialport/doc/src/index.qdoc index 0f8d275..ad49586 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 e549717..be28b67 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 436de12..ff5ec85 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. */ -- cgit v1.2.1