Update .qdoc files

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
+### Usage(1): Use Xlsx as Qt5's addon module
-
-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. For example, 3rdparty:
+* Put the source code in any directory you like. At the toplevel directory run
-
-```
-    |-- project.pro
-    |-- ....
-    |-- 3rdparty\
-    |     |-- qtxlsx\
-    |     |
-```
 
-* 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
+    |-- project.pro
-    make
+    |-- ....
-    make install
+    |-- 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/

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.

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.

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.

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-examples
-    \ingroup qtxlsx
 
     This example demonstrates how to generate a
     .xlsx file with Qt Xlsx Library.

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:
+*/

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
+    To include the definitions of the module's classes, using the following directive:
-
-    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)
+    #include <QtXlsx>
     \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:
+    To link against the module, add this line to your qmake .pro 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:
 
     \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
+        \li \l{Qt Xlsx Examples}
-
-    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}
     \endlist
 */

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
+*/