Add basic document files
This commit is contained in:
@@ -0,0 +1,46 @@
|
||||
include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)
|
||||
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
|
||||
|
||||
project = QtXlsx
|
||||
description = Qt Xlsx Reference Documentation
|
||||
url = http://qtxlsx.debao.me
|
||||
version = $QT_VERSION
|
||||
|
||||
qhp.projects = QtXlsx
|
||||
|
||||
qhp.QtXlsx.file = qtxlsx.qhp
|
||||
qhp.QtXlsx.namespace = me.debao.qtxlsx.$QT_VERSION_TAG
|
||||
qhp.QtXlsx.virtualFolder = qtxlsx
|
||||
qhp.QtXlsx.indexTitle = Qt Xlsx
|
||||
qhp.QtXlsx.indexRoot =
|
||||
|
||||
qhp.QtXlsx.filterAttributes = qtxlsx $QT_VERSION qtrefdoc
|
||||
qhp.QtXlsx.customFilters.Qt.name = QtXlsx $QT_VERSION
|
||||
qhp.QtXlsx.customFilters.Qt.filterAttributes = qtxlsx $QT_VERSION
|
||||
qhp.QtXlsx.subprojects = overviews classes qmltypes examples
|
||||
qhp.QtXlsx.subprojects.overviews.title = Overview
|
||||
qhp.QtXlsx.subprojects.overviews.indexTitle = Qt Xlsx
|
||||
qhp.QtXlsx.subprojects.overviews.selectors = fake:page,group,module
|
||||
qhp.QtXlsx.subprojects.classes.title = C++ Classes
|
||||
qhp.QtXlsx.subprojects.classes.indexTitle = Qt Xlsx C++ Classes
|
||||
qhp.QtXlsx.subprojects.classes.selectors = class fake:headerfile
|
||||
qhp.QtXlsx.subprojects.classes.sortPages = true
|
||||
qhp.QtXlsx.subprojects.examples.title = Examples
|
||||
qhp.QtXlsx.subprojects.examples.indexTitle = Qt Xlsx Examples
|
||||
qhp.QtXlsx.subprojects.examples.selectors = fake:example
|
||||
|
||||
tagfile = ../../../doc/qtxlsx/qtxlsx.tags
|
||||
|
||||
headerdirs += ..
|
||||
|
||||
sourcedirs += ..
|
||||
|
||||
exampledirs += ../../../examples/xlsx \
|
||||
snippets/
|
||||
|
||||
# Specify the install path under QT_INSTALL_EXAMPLES
|
||||
examplesinstallpath = xlsx
|
||||
|
||||
imagedirs += images
|
||||
|
||||
depends += qtcore qtdoc qtgui
|
||||
@@ -0,0 +1,8 @@
|
||||
|
||||
//! [0]
|
||||
#include <QtXlsx>
|
||||
//! [0]
|
||||
|
||||
//! [1]
|
||||
#include <QtXlsx>
|
||||
//! [1]
|
||||
@@ -0,0 +1,3 @@
|
||||
#! [1]
|
||||
QT += xlsx
|
||||
#! [1]
|
||||
@@ -0,0 +1,58 @@
|
||||
/****************************************************************************
|
||||
** Copyright (c) 2013 Debao Zhang <hello@debao.me>
|
||||
** All right reserved.
|
||||
**
|
||||
** Permission is hereby granted, free of charge, to any person obtaining
|
||||
** a copy of this software and associated documentation files (the
|
||||
** "Software"), to deal in the Software without restriction, including
|
||||
** without limitation the rights to use, copy, modify, merge, publish,
|
||||
** distribute, sublicense, and/or sell copies of the Software, and to
|
||||
** permit persons to whom the Software is furnished to do so, subject to
|
||||
** the following conditions:
|
||||
**
|
||||
** The above copyright notice and this permission notice shall be
|
||||
** included in all copies or substantial portions of the Software.
|
||||
**
|
||||
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
** MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
** NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
** LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
** OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
** WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
/*!
|
||||
\title Qt Xlsx
|
||||
\page qtxlsx-index.html
|
||||
\brief Qt Xlsx provides functionality for handling .xlsx files.
|
||||
|
||||
.xlsx is a zipped, XML-based file format developed by Microsoft for
|
||||
representing spreadsheets.
|
||||
|
||||
\section1 Getting Started
|
||||
|
||||
Qt Xlsx provides classes for writing .xlsx files. To include the definitions
|
||||
of the module's classes, use the following directive:
|
||||
|
||||
\snippet doc_src_qtxlsx.cpp 0
|
||||
|
||||
To link against the module, add this line to your qmake \c
|
||||
.pro file:
|
||||
|
||||
\snippet doc_src_qtxlsx.pro 1
|
||||
|
||||
\section1 References
|
||||
\list
|
||||
\li \l{Qt Xlsx C++ Classes}
|
||||
\endlist
|
||||
|
||||
Qt Xlsx comes with the following examples:
|
||||
|
||||
\list
|
||||
\li \l{Xlsx Hello Example}
|
||||
\li \l{Xlsx Style Example}
|
||||
\li \l{Xlsx DocProperties Example}
|
||||
\endlist
|
||||
*/
|
||||
@@ -0,0 +1,36 @@
|
||||
/****************************************************************************
|
||||
** Copyright (c) 2013 Debao Zhang <hello@debao.me>
|
||||
** All right reserved.
|
||||
**
|
||||
** Permission is hereby granted, free of charge, to any person obtaining
|
||||
** a copy of this software and associated documentation files (the
|
||||
** "Software"), to deal in the Software without restriction, including
|
||||
** without limitation the rights to use, copy, modify, merge, publish,
|
||||
** distribute, sublicense, and/or sell copies of the Software, and to
|
||||
** permit persons to whom the Software is furnished to do so, subject to
|
||||
** the following conditions:
|
||||
**
|
||||
** The above copyright notice and this permission notice shall be
|
||||
** included in all copies or substantial portions of the Software.
|
||||
**
|
||||
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
** MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
** NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
** LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
** OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
** WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
/*!
|
||||
\module QtXlsx
|
||||
\title Qt Xlsx C++ Classes
|
||||
\ingroup modules
|
||||
|
||||
\brief The Qt Xlsx module provides functionality for handling .xlsx files.
|
||||
|
||||
.xlsx is a zipped, XML-based file format developed by Microsoft for
|
||||
representing spreadsheets.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user