summaryrefslogtreecommitdiffstats
path: root/examples/serialport/doc/cenumerator.qdoc
blob: f07a79a6a0e8a274c8b6bcc1711425ca19aa6a63 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Copyright (C) 2012 Laszlo Papp <lpapp@kde.org>
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \example cenumerator
    \title Command Line Enumerator Example
    \ingroup qtserialport-examples
    \brief Shows how to get information about serial devices in a 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

    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
*/