summaryrefslogtreecommitdiffstats
path: root/examples/serialport/doc/cenumerator.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/serialport/doc/cenumerator.qdoc')
-rw-r--r--examples/serialport/doc/cenumerator.qdoc14
1 files changed, 8 insertions, 6 deletions
diff --git a/examples/serialport/doc/cenumerator.qdoc b/examples/serialport/doc/cenumerator.qdoc
index 0766931a..83718982 100644
--- a/examples/serialport/doc/cenumerator.qdoc
+++ b/examples/serialport/doc/cenumerator.qdoc
@@ -1,6 +1,7 @@
/****************************************************************************
**
** Copyright (C) 2012 Laszlo Papp <lpapp@kde.org>
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
@@ -28,18 +29,19 @@
/*!
\example cenumerator
\title Command Line Enumerator Example
- \ingroup qtserialport-examples
+ \ingroup qtserialport-example
+ \brief Shows how to get information about serial devices in a system.
- The Command Line Enumerator example shows how to use the class
- QSerialPortInfo for getting information about serial devices that are present
- in the system.
+ \e{Command Line Enumerator} shows how to use the class QSerialPortInfo for
+ getting information about serial devices that are present in the system.
- \image cenumerator-example.png Screenshot of the Command Line Enumerator
- example
+ \image cenumerator-example.png
This command line example displays information about serial ports in a
console, provided by the class QSerialPortInfo.
For getting information about the available ports, use the static method
\l{QSerialPortInfo::availablePorts()}{availablePorts()}.
+
+ \include examples-run.qdocinc
*/