qt-everywhere-src-5.15.1/qtserialport/examples/serialport/doc/enumerator.qdoc

/****************************************************************************
**
** Copyright (C) 2011 - 2012 Denis Shienkov <denis.shienkov@gmail.com>
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \example enumerator
    \title Enumerator Example
    \ingroup qtserialport-examples
    \brief Shows how to display information about serial devices in a system.

    \e Enumerator shows how to use the class QSerialPortInfo for
    getting information about serial devices that are present in the system.

    \image enumerator-example.png

    This GUI example displays information about serial ports in a widget,
    provided by the class QSerialPortInfo.

    For getting information about the available ports, use the static method
    \l{QSerialPortInfo::availablePorts()}{availablePorts()}.

    \include examples-run.qdocinc
*/