diff options
Diffstat (limited to 'src/macextras/doc/src/qtmacextras-index.qdoc')
-rw-r--r-- | src/macextras/doc/src/qtmacextras-index.qdoc | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/src/macextras/doc/src/qtmacextras-index.qdoc b/src/macextras/doc/src/qtmacextras-index.qdoc new file mode 100644 index 0000000..f0af333 --- /dev/null +++ b/src/macextras/doc/src/qtmacextras-index.qdoc @@ -0,0 +1,71 @@ +/**************************************************************************** +** +** Copyright (C) 2013 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. +** +** $QT_BEGIN_LICENSE:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names +** of its contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtmacextras-index.html + \title Qt Mac Extras + \brief Provides functionality specific to Mac OS X and iOS operating systems. + + Qt Mac Extras provide classes and functions that enable you to use + miscellaneous functionality specific to Mac OS X and iOS operating systems. + + \section1 Getting Started + + To include the definitions of the module's classes and functions, use the + following include statement: + + \snippet code/use-qtmacextras.cpp include + + To link against the module, add this line to your qmake .pro file: + + \snippet code/use-qtmacextras.pro link + + \section1 Examples + + \list + \li \l {Qt Mac Extras Examples} + \endlist + + \section1 API Reference + + \list + \li \l {Qt Mac Extras C++ Classes}{C++ Classes and Namespaces} + \endlist +*/ |