From d8c1f360a2f9dd3cd3135f4b3b238feded16219b Mon Sep 17 00:00:00 2001 From: Debao Zhang Date: Wed, 30 Oct 2013 17:35:42 +0800 Subject: [PATCH] Update .qdoc files --- README.md | 53 +++++++------ .../doc/src/documentproperty.qdoc | 2 +- examples/xlsx/hello/doc/src/hello.qdoc | 2 +- .../xlsx/readwrite/doc/src/readwrite.qdoc | 2 +- examples/xlsx/style/doc/src/style.qdoc | 3 +- src/xlsx/doc/src/examples.qdoc | 8 ++ src/xlsx/doc/src/qtxlsx-index.qdoc | 74 ++----------------- src/xlsx/doc/src/usage.qdoc | 70 ++++++++++++++++++ 8 files changed, 114 insertions(+), 100 deletions(-) create mode 100644 src/xlsx/doc/src/examples.qdoc create mode 100644 src/xlsx/doc/src/usage.qdoc diff --git a/README.md b/README.md index f84b798..20e1ff9 100644 --- a/README.md +++ b/README.md @@ -4,32 +4,26 @@ QtXlsx is a library that can read and write Excel files. It doesn't require Micr ## Getting Started -### Usage(1): Use source code directly - -The package contains a **qtxlsx.pri** file that allows you to integrate the component into applications that use qmake for the build step. +### Usage(1): Use Xlsx as Qt5's addon module * Download the source code. -* Put the source code in any directory you like. For example, 3rdparty: - -``` - |-- project.pro - |-- .... - |-- 3rdparty\ - | |-- qtxlsx\ - | | -``` +* Put the source code in any directory you like. At the toplevel directory run -* Add following line to your qmake project file: +**Note**: Perl is needed. ``` - include(3rdparty/qtxlsx/src/xlsx/qtxlsx.pri) + qmake + make + make install ``` -**Note**: If you like, you can copy all files from *src/xlsx* to your application's source path. Then add following line to your project file: +The library, the header files, and others will be installed to your system. + +* Add following line to your qmake's project file: ``` - include(qtxlsx.pri) + QT += xlsx ``` * Then, using Qt Xlsx in your code @@ -45,26 +39,32 @@ The package contains a **qtxlsx.pri** file that allows you to integrate the comp } ``` -### Usage(2): Use Xlsx as Qt5's addon module +### Usage(2): Use source code directly -**Note**: Perl is needed. +The package contains a **qtxlsx.pri** file that allows you to integrate the component into applications that use qmake for the build step. * Download the source code. -* Put the source code in any directory you like. At the toplevel directory run +* Put the source code in any directory you like. For example, 3rdparty: ``` - qmake - make - make install + |-- project.pro + |-- .... + |-- 3rdparty\ + | |-- qtxlsx\ + | | ``` -The library, the header files, and the feature file will be installed to your system. +* Add following line to your qmake project file: -* Add following line to your qmake's project file: +``` + include(3rdparty/qtxlsx/src/xlsx/qtxlsx.pri) +``` + +**Note**: If you like, you can copy all files from *src/xlsx* to your application's source path. Then add following line to your project file: ``` - QT += xlsx + include(qtxlsx.pri) ``` * Then, using Qt Xlsx in your code @@ -76,9 +76,6 @@ The library, the header files, and the feature file will be installed to your sy * http://officeopenxml.com/anatomyofOOXML-xlsx.php * http://www.libxl.com * http://closedxml.codeplex.com/ -* http://search.cpan.org/~jmcnamara/Excel-Writer-XLSX-0.71/ -* http://www.codeproject.com/Articles/208075/How-to-read-and-write-xlsx-Excel-2007-file-Part-I -* http://www.codeproject.com/Articles/210014/How-to-read-and-write-xlsx-Excel-2007-file-Part-II * http://epplus.codeplex.com/ * http://excelpackage.codeplex.com/ * http://spreadsheetlight.com/ diff --git a/examples/xlsx/documentproperty/doc/src/documentproperty.qdoc b/examples/xlsx/documentproperty/doc/src/documentproperty.qdoc index 84c1f14..e04aa90 100644 --- a/examples/xlsx/documentproperty/doc/src/documentproperty.qdoc +++ b/examples/xlsx/documentproperty/doc/src/documentproperty.qdoc @@ -4,7 +4,7 @@ \title Xlsx DocProperties Example \brief This is a simplest xlsx examples. - \ingroup qtxlsx + \ingroup qtxlsx-examples This example demonstrates how to generate a .xlsx file with Qt Xlsx Library. diff --git a/examples/xlsx/hello/doc/src/hello.qdoc b/examples/xlsx/hello/doc/src/hello.qdoc index 6549013..c35fba9 100644 --- a/examples/xlsx/hello/doc/src/hello.qdoc +++ b/examples/xlsx/hello/doc/src/hello.qdoc @@ -2,7 +2,7 @@ \example hello \title Xlsx Hello Example \brief This is a simplest xlsx examples. - \ingroup qtxlsx + \ingroup qtxlsx-examples This example demonstrates how to generate a simplest .xlsx file with Qt Xlsx Library. diff --git a/examples/xlsx/readwrite/doc/src/readwrite.qdoc b/examples/xlsx/readwrite/doc/src/readwrite.qdoc index 39da209..463a26a 100644 --- a/examples/xlsx/readwrite/doc/src/readwrite.qdoc +++ b/examples/xlsx/readwrite/doc/src/readwrite.qdoc @@ -2,7 +2,7 @@ \title Xlsx Readwrite Example \example readwrite \brief Open an existing xlsx file, modify and save it. - \ingroup qtxlsx + \ingroup qtxlsx-examples This example demonstrates how to modify an existing .xlsx file with Qt Xlsx Library. diff --git a/examples/xlsx/style/doc/src/style.qdoc b/examples/xlsx/style/doc/src/style.qdoc index fca9171..c24bb7b 100644 --- a/examples/xlsx/style/doc/src/style.qdoc +++ b/examples/xlsx/style/doc/src/style.qdoc @@ -3,8 +3,7 @@ \example style \title Xlsx Style Example \brief This is a simplest xlsx examples. - - \ingroup qtxlsx + \ingroup qtxlsx-examples This example demonstrates how to generate a .xlsx file with Qt Xlsx Library. diff --git a/src/xlsx/doc/src/examples.qdoc b/src/xlsx/doc/src/examples.qdoc new file mode 100644 index 0000000..6defee7 --- /dev/null +++ b/src/xlsx/doc/src/examples.qdoc @@ -0,0 +1,8 @@ +/*! + \group qtxlsx-examples + \title Qt Xlsx Examples + \brief Examples for the Qt Xlsx module + \ingroup all-examples + + Qt Xlsx comes with the following examples: +*/ diff --git a/src/xlsx/doc/src/qtxlsx-index.qdoc b/src/xlsx/doc/src/qtxlsx-index.qdoc index b2454f2..059d793 100644 --- a/src/xlsx/doc/src/qtxlsx-index.qdoc +++ b/src/xlsx/doc/src/qtxlsx-index.qdoc @@ -28,88 +28,28 @@ \page index.html \brief Qt Xlsx provides functionality for handling .xlsx files. - QtXlsx is a library that can read and write Excel files. It doesn't require + The \l{Qt Xlsx C++ Classes}{Qt Xlsx Module} provides a set of classes to read and write Excel files. It doesn't require Microsoft Excel and can be used in any platform that Qt5 supported. \section1 Getting Started - \section2 Usage(1): Use source code directly - - The package contains a qtxlsx.pri file that allows you to integrate - the component into applications that use qmake for the build step. - - 1. Download the source code from \l {https://github.com/dbzhang800/QtXlsxWriter/archive/master.zip} {github.com} - - 2. Put the source code in any directory you like. For example, 3rdparty: - - \code - |-- project.pro - |-- .... - |-- 3rdparty\ - | |-- qtxlsx\ - | | - \endcode - - 3. Add following line to your qmake project file: + To include the definitions of the module's classes, using the following directive: \code - include(3rdparty/qtxlsx/src/xlsx/qtxlsx.pri) + #include \endcode - \note If you like, you can copy all files from *src/xlsx* to your application's source path. Then add following line to your project file: - - \code - include(qtxlsx.pri) - \endcode - - 4. Then, using Qt Xlsx in your code - - \code - #include "xlsxdocument.h" - int main() - { - QXlsx::Document xlsx; - xlsx.write("A1", "Hello Qt!"); - xlsx.saveAs("Test.xlsx"); - return 0; - } - \endcode - - \section2 Usage(2): Use Xlsx as Qt5's addon module - - \note Perl is needed. - - 1. Download the source code. - - 2. Put the source code in any directory you like. At the toplevel directory run - - \code - qmake - make - make install - \endcode - - The library, the header files, and the feature file will be installed to your system. - - 3. Add following line to your qmake's project file: + To link against the module, add this line to your qmake .pro file: \code QT += xlsx \endcode - 4. Then, using Qt Xlsx in your code + More information can be found in \l{Qt Xlsx Build} page. - \section1 References + \section1 Related information \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} - \li \l{Xlsx Readwrite Example} + \li \l{Qt Xlsx Examples} \endlist */ diff --git a/src/xlsx/doc/src/usage.qdoc b/src/xlsx/doc/src/usage.qdoc new file mode 100644 index 0000000..4306b02 --- /dev/null +++ b/src/xlsx/doc/src/usage.qdoc @@ -0,0 +1,70 @@ +/*! + \page building + \title Qt Xlsx Build + + \section1 Usage(1): Use Xlsx as Qt5's addon module + + 1. Download the source code from \l {https://github.com/dbzhang800/QtXlsxWriter/archive/master.zip} {github.com}. + + 2. Put the source code in any directory you like. At the toplevel directory run + + \note Perl is needed in this step. + + \code + qmake + make + make install + \endcode + + The library, the header files, and others will be installed to your system. + + 3. Add following line to your qmake's project file: + + \code + QT += xlsx + \endcode + + 4. Then, using Qt Xlsx in your code + + \code + #include "xlsxdocument.h" + int main() + { + QXlsx::Document xlsx; + xlsx.write("A1", "Hello Qt!"); + xlsx.saveAs("Test.xlsx"); + return 0; + } + \endcode + + \section1 Usage(2): Use source code directly + + The package contains a qtxlsx.pri file that allows you to integrate + the component into applications that use qmake for the build step. + + 1. Download the source code from \l {https://github.com/dbzhang800/QtXlsxWriter/archive/master.zip} {github.com} + + 2. Put the source code in any directory you like. For example, 3rdparty: + + \code + |-- project.pro + |-- .... + |-- 3rdparty\ + | |-- qtxlsx\ + | | + \endcode + + 3. Add following line to your qmake project file: + + \code + include(3rdparty/qtxlsx/src/xlsx/qtxlsx.pri) + \endcode + + \note If you like, you can copy all files from *src/xlsx* to your application's source path. Then add following line to your project file: + + \code + include(qtxlsx.pri) + \endcode + + 4. Then, using Qt Xlsx in your code +*/