Doc: fix doc generation and add module overview (landing) page
Change-Id: I68df54cfa83a600d7fc3ada0437ffec0b14c385b Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
This commit is contained in:
parent
7f4644f6ed
commit
473a7db4e2
|
@ -8,10 +8,12 @@ version = 5.0.0
|
||||||
|
|
||||||
# Directories in which to search for files to document.
|
# Directories in which to search for files to document.
|
||||||
# Paths are relative to the location of this file.
|
# Paths are relative to the location of this file.
|
||||||
exampledirs += ../examples
|
# exampledirs += ../examples
|
||||||
# headerdirs +=
|
# headerdirs +=
|
||||||
imagedirs += images
|
# imagedirs += images
|
||||||
# sourcedirs +=
|
sourcedirs += src
|
||||||
|
|
||||||
|
depends += qtcore qtgui
|
||||||
|
|
||||||
# The following parameters are for creating a qhp file, the qhelpgenerator
|
# The following parameters are for creating a qhp file, the qhelpgenerator
|
||||||
# program can convert the qhp file into a qch file which can be opened in
|
# program can convert the qhp file into a qch file which can be opened in
|
||||||
|
@ -60,10 +62,3 @@ examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"
|
||||||
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
|
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
|
||||||
sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
|
sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
|
||||||
|
|
||||||
HTML.nobreadcrumbs = "true"
|
|
||||||
|
|
||||||
HTML.templatedir = .
|
|
||||||
HTML.stylesheets = style/style.css
|
|
||||||
|
|
||||||
HTML.headerstyles = " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/style.css\" />\n"
|
|
||||||
HTML.endheader = "</head>\n"
|
|
|
@ -0,0 +1,69 @@
|
||||||
|
/****************************************************************************
|
||||||
|
**
|
||||||
|
** 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 Image Formats 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$
|
||||||
|
**
|
||||||
|
****************************************************************************/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\title Qt Image Formats
|
||||||
|
\page qtimageformats-index.html
|
||||||
|
\brief Qt Image Formats module provides support for extra image file formats
|
||||||
|
|
||||||
|
The core Qt Gui library by default supports reading and writing image
|
||||||
|
files of the most common file formats: \c PNG, \c JPEG, \c BMP, \c GIF
|
||||||
|
and a few more, ref. \l {QImage#Reading and Writing Image Files}{Reading
|
||||||
|
and Writing Image Files}. The Qt Image Formats add-on module provides
|
||||||
|
optional support for other image file formats.
|
||||||
|
|
||||||
|
The file format support is provided transparently, through plugins for
|
||||||
|
Qt's image I/O system. As such, this module provides no API of its
|
||||||
|
own. Instead, the functionality is accessed in the same way as other
|
||||||
|
image I/O in Qt: through QImage::load() and QImage::save(). Or, for
|
||||||
|
more detailed control, through QImageReader and QImageWriter.
|
||||||
|
|
||||||
|
\section1 The Image I/O Plugins
|
||||||
|
|
||||||
|
The actual coding and decoding of the file format is done by a codec
|
||||||
|
library. The codec can be Qt or third party code. In case of a third
|
||||||
|
party codec, the build process will look for it among the system
|
||||||
|
libraries. If not found, it may fall back on using a bundled copy (in
|
||||||
|
\c src/3rdparty).
|
||||||
|
|
||||||
|
\table
|
||||||
|
\header \li Format \li Description \li Support \li 3rd party codec
|
||||||
|
\row \li MNG \li Multiple-image Network Graphics \li Read/write \li Yes (bundled)
|
||||||
|
\row \li TGA \li Truevision Graphics Adapter \li Read/write \li No
|
||||||
|
\row \li TIFF \li Tagged Image File Format \li Read/write \li Yes (bundled)
|
||||||
|
\row \li WBMP \li Wireless Bitmap \li Read/write \li No
|
||||||
|
\endtable
|
||||||
|
|
||||||
|
\section2 Security considerations
|
||||||
|
|
||||||
|
Since these file formats are more rarely used, the codecs may be less
|
||||||
|
thoroughly debugged against potential security holes. As always, care
|
||||||
|
should be taken when creating applications that may be used to decode
|
||||||
|
uncontrolled data files.
|
||||||
|
|
||||||
|
|
||||||
|
*/
|
|
@ -0,0 +1,7 @@
|
||||||
|
TEMPLATE = aux
|
||||||
|
|
||||||
|
QMAKE_DOCS = $$PWD/doc/qtimageformats.qdocconf
|
||||||
|
QMAKE_DOCS_BASE_OUTDIR = $$[QT_INSTALL_DOCS]
|
||||||
|
QMAKE_DOCS_OUTPUTDIR = $$[QT_INSTALL_DOCS]/qtimageformats
|
||||||
|
QMAKE_DOCS_TARGET = qtimageformats
|
||||||
|
CONFIG += qt_install_module_docs
|
|
@ -1,2 +1,2 @@
|
||||||
TEMPLATE = subdirs
|
TEMPLATE = subdirs
|
||||||
SUBDIRS = plugins
|
SUBDIRS = plugins imageformats
|
||||||
|
|
Loading…
Reference in New Issue