diff options
Diffstat (limited to 'src/modelingwidgets/doc')
4 files changed, 153 insertions, 0 deletions
diff --git a/src/modelingwidgets/doc/qtmodelingwidgets.qdocconf b/src/modelingwidgets/doc/qtmodelingwidgets.qdocconf new file mode 100644 index 00000000..fd4cc041 --- /dev/null +++ b/src/modelingwidgets/doc/qtmodelingwidgets.qdocconf @@ -0,0 +1,41 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) + +project = QtModelingWidgets +description = Qt ModelingWidgets Reference Documentation +url = http://qt-project.org/doc/qtmodelingwidgets +version = 5.0.0 + +examplesinstallpath = modelingwidgets + +qhp.projects = QtModelingWidgets + +qhp.QtModelingWidgets.file = qtmodelingwidgets.qhp +qhp.QtModelingWidgets.namespace = org.qt-project.qtmodelingwidgets.500 +qhp.QtModelingWidgets.virtualFolder = qtmodelingwidgets +qhp.QtModelingWidgets.indexTitle = Qt ModelingWidgets +qhp.QtModelingWidgets.indexRoot = + +qhp.QtModelingWidgets.filterAttributes = qtmodelingwidgets 5.0.0 qtrefdoc +qhp.QtModelingWidgets.customFilters.Qt.name = QtModelingWidgets 5.0.0 +qhp.QtModelingWidgets.customFilters.Qt.filterAttributes = qtmodelingwidgets 5.0.0 + +qhp.QtModelingWidgets.subprojects = classes +qhp.QtModelingWidgets.subprojects.classes.title = C++ Classes +qhp.QtModelingWidgets.subprojects.classes.indexTitle = Qt ModelingWidgets C++ Classes +qhp.QtModelingWidgets.subprojects.classes.selectors = class fake:headerfile +qhp.QtModelingWidgets.subprojects.classes.sortPages = true +tagfile = ../../../doc/qtmodelingwidgets/qtmodelingwidgets.tags + +depends += qtcore modeling qtdoc + +headerdirs += .. + +sourcedirs += .. \ + ../../../examples/modelingwidgets/doc/src + +exampledirs += ../../../examples/modelingwidgets \ + ../ \ + snippets + +imagedirs += images \ + ../../../examples/modelingwidgets/doc/images diff --git a/src/modelingwidgets/doc/snippets/code/doc_src_qtmodelingwidgets.cpp b/src/modelingwidgets/doc/snippets/code/doc_src_qtmodelingwidgets.cpp new file mode 100644 index 00000000..d7a24615 --- /dev/null +++ b/src/modelingwidgets/doc/snippets/code/doc_src_qtmodelingwidgets.cpp @@ -0,0 +1,43 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Sandro S. Andrade <sandroandrade@kde.org> +** Contact: http://www.qt-project.org/legal +** +** This file is part of the QtModelingWidgets module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** 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 Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +//! [0] +#include <QtModelingWidgets> +//! [0] diff --git a/src/modelingwidgets/doc/snippets/code/doc_src_qtmodelingwidgets.pro b/src/modelingwidgets/doc/snippets/code/doc_src_qtmodelingwidgets.pro new file mode 100644 index 00000000..f98b6b53 --- /dev/null +++ b/src/modelingwidgets/doc/snippets/code/doc_src_qtmodelingwidgets.pro @@ -0,0 +1,3 @@ +#! [0] +QT += modelingwidgets +#! [0] diff --git a/src/modelingwidgets/doc/src/qtmodelingwidgets.qdoc b/src/modelingwidgets/doc/src/qtmodelingwidgets.qdoc new file mode 100644 index 00000000..e7a1d71c --- /dev/null +++ b/src/modelingwidgets/doc/src/qtmodelingwidgets.qdoc @@ -0,0 +1,66 @@ +/**************************************************************************** +** +** Copyright (C) 2012 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: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 Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/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: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ +/*! + \page qtmodelingwidgets-index.html + \title Qt ModelingWidgets + \brief Provide model and widget classes for use with QtModelingWidgets module. + + Qt ModelingWidgets is an add-on module which provides model and widget classes for use with QtModelingWidgets module. + + \section1 Getting Started + To enable Qt ModelingWidgets in a project, add this directive into the C++ files: + \code + #include <QtModelingWidgets> + \endcode + To link against the Qt ModelingWidgets module, add this line to the project file: + \code + QT += modelingwidgets + \endcode + + \section1 Reference + These are links to the API reference materials. + \list + \li \l{Qt ModelingWidgets Module C++ Classes}{C++ classes} + \endlist +*/ + +/*! + \module QtModelingWidgets + \title Qt ModelingWidgets Module C++ Classes + \ingroup modules + \brief Provide model and widget classes for use with QtModelingWidgets module. + + To include the definitions of the module's classes, use the + following directive: + + \snippet code/doc_src_qtmodelingwidgets.cpp 0 + + To link against the module, add this line to your \l qmake \c + .pro file: + + \snippet code/doc_src_qtmodelingwidgets.pro 0 +*/ |