Doc: Adding documentation from qtdoc repository

-snippets
-license information
-overview

Change-Id: I75ec50cfd4f1ef3d8753a3c14b34dc748adf9b54
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>

5 files changed, 246 insertions, 1 deletions

diff --git a/src/svg/doc/snippets/doc_src_qtsvg.cpp b/src/svg/doc/snippets/doc_src_qtsvg.cpp
new file mode 100644
index 0000000..3fdddf2
--- /dev/null
+++ b/src/svg/doc/snippets/doc_src_qtsvg.cpp
@@ -0,0 +1,43 @@
+/****************************************************************************
+**
+** 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: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$
+**
+****************************************************************************/
+
+//! [0]
+#include <QtSvg>
+//! [0]
diff --git a/src/svg/doc/snippets/doc_src_qtsvg.pro b/src/svg/doc/snippets/doc_src_qtsvg.pro
new file mode 100644
index 0000000..c748f13
--- /dev/null
+++ b/src/svg/doc/snippets/doc_src_qtsvg.pro
@@ -0,0 +1,43 @@
+/****************************************************************************
+**
+** 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: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$
+**
+****************************************************************************/
+
+#! [1]
+QT += svg
+#! [1]
diff --git a/src/svg/doc/src/qtsvg-index.qdoc b/src/svg/doc/src/qtsvg-index.qdoc
index 10b39be..6208646 100644
--- a/src/svg/doc/src/qtsvg-index.qdoc
+++ b/src/svg/doc/src/qtsvg-index.qdoc
@@ -35,6 +35,26 @@
     for rendering and displaying SVG drawings in widgets and on other
     paint devices.
 
+    \section1 Getting Started
+
+    Qt SVG provides classes for rendering SVG files. To include the definitions
+    of the module's classes, use the following directive:
+
+    \snippet doc_src_qtsvg.cpp 0
+
+    To link against the module, add this line to your \l qmake \c
+    .pro file:
+
+    \snippet doc_src_qtsvg.pro 1
+
+    \section1 Articles
+    \list
+    \li \l{Rendering SVG Files} contains information about how to
+    render SVG files
+    \li \l{Qt SVG License Information}{License Information}
+    \endlist
+
+    \section1 References
     \list
         \li \l{Qt Svg C++ Classes}
     \endlist
@@ -46,4 +66,3 @@
         \li \l{SVG Viewer Example}
     \endlist
 */
-
diff --git a/src/svg/doc/src/svglicense.qdoc b/src/svg/doc/src/svglicense.qdoc
new file mode 100644
index 0000000..9aa5e1b
--- /dev/null
+++ b/src/svg/doc/src/svglicense.qdoc
@@ -0,0 +1,62 @@
+/****************************************************************************
+**
+** 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 Svg Module.
+**
+** $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 qtsvglicense.html
+    \title Qt SVG License Information
+    \ingroup licensing
+    \brief License information for Qt SVG
+
+    Some code for arc handling in the \l{Qt SVG} module is derived from code
+    with the following license:
+
+    \legalese
+    Copyright  2002 USC/Information Sciences Institute
+
+    Permission to use, copy, modify, distribute, and sell this software
+    and its documentation for any purpose is hereby granted without
+    fee, provided that the above copyright notice appear in all copies
+    and that both that copyright notice and this permission notice
+    appear in supporting documentation, and that the name of
+    Information Sciences Institute not be used in advertising or
+    publicity pertaining to distribution of the software without
+    specific, written prior permission.  Information Sciences Institute
+    makes no representations about the suitability of this software for
+    any purpose.  It is provided "as is" without express or implied
+    warranty.
+
+    INFORMATION SCIENCES INSTITUTE DISCLAIMS ALL WARRANTIES WITH REGARD
+    TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
+    MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL INFORMATION SCIENCES
+    INSTITUTE BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
+    DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
+    OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+    PERFORMANCE OF THIS SOFTWARE.
+    \endlegalese
+
+*/
diff --git a/src/svg/doc/src/svgrendering.qdoc b/src/svg/doc/src/svgrendering.qdoc
new file mode 100644
index 0000000..02e4e12
--- /dev/null
+++ b/src/svg/doc/src/svgrendering.qdoc
@@ -0,0 +1,78 @@
+/****************************************************************************
+**
+** 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 Svg Module.
+**
+** $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 svgrendering.html
+    \title Rendering SVG Files
+    \brief Rendering SVG files with the Qt SVG module
+
+    Qt SVG provides classes for rendering SVG files. To include the definitions
+    of the module's classes, use the following directive:
+
+    \snippet doc_src_qtsvg.cpp 0
+
+    To link against the module, add this line to your \l qmake \c
+    .pro file:
+
+    \snippet doc_src_qtsvg.pro 1
+
+    \section1 Rendering SVG files
+
+    Scalable Vector Graphics (SVG) is a language for describing two-dimensional
+    graphics and graphical applications in XML. SVG 1.1 is a W3C Recommendation
+    and forms the core of the current SVG developments in Qt. SVG 1.2 is the
+    specification currently being developed by the \l{SVG Working Group}, and it
+    is \l{http://www.w3.org/TR/SVG12/}{available in draft form}. The \l{Mobile
+    SVG Profiles} (SVG Basic and SVG Tiny) are aimed at resource-limited devices
+    and are part of the 3GPP platform for third generation mobile phones. You
+    can read more about SVG at \l{About SVG}.
+
+    Qt supports the \l{SVG 1.2 Tiny Static Features}{static features} of
+    \l{SVG 1.2 Tiny}. ECMA scripts and DOM manipulation are currently not
+    supported.
+
+    SVG drawings can be rendered onto any QPaintDevice subclass. This
+    approach gives developers the flexibility to experiment, in order
+    to find the best solution for each application.
+
+    The easiest way to render SVG files is to construct a QSvgWidget and
+    load an SVG file using one of the QSvgWidget::load() functions.
+
+    QSvgRenderer is the class responsible for rendering SVG files for
+    QSvgWidget, and it can be used directly to provide SVG support for
+    custom widgets.
+    To load an SVG file, construct a QSvgRenderer with a file name or the
+    contents of a file, or call QSvgRenderer::load() on an existing
+    renderer. If the SVG file has been loaded successfully the
+    QSvgRenderer::isValid() will return true.
+
+    Once you have loaded the SVG file successfully, you can render it
+    with the QSvgRenderer::render() function. Note that this scheme allows
+    you to render SVG files on all paint devices supported by Qt, including
+    QWidget, QGLWidget, and QImage. See the \l{SVG Viewer Example}{SVG Viewer}
+    example for more details.
+*/