Integrate QT documentation into doxygen

This commit is contained in:
Tobias Taschner
2018-10-03 19:16:39 +02:00
parent f8460059cd
commit 141b5bdf0f
4 changed files with 83 additions and 78 deletions

View File

@@ -296,6 +296,7 @@ INPUT = mainpages \
../ios \ ../ios \
../msw \ ../msw \
../osx \ ../osx \
../qt \
../../interface ../../interface
INPUT_ENCODING = UTF-8 INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.h *.md FILE_PATTERNS = *.h *.md

View File

@@ -167,7 +167,9 @@ wxWindowBase::GetDefaultBorder(), returning wxBORDER_NONE.
wxQt is a port of wxWidgets using Qt libraries. It requires Qt 5 or later. wxQt is a port of wxWidgets using Qt libraries. It requires Qt 5 or later.
For further information, please see the files in docs/qt in the distribution. @subpage plat_qt_install "Build Instructions"
@subpage plat_qt_architecture "Architecture Overview"
@section page_port_wxiOS wxiOS @section page_port_wxiOS wxiOS

View File

@@ -1,4 +1,4 @@
# wxQt Architecture # wxQt Architecture {#plat_qt_architecture}
## Internals ## Internals

View File

@@ -1,6 +1,8 @@
wxWidgets for Qt installation wxWidgets for Qt installation {#plat_qt_install}
----------------------------- -----------------------------
[TOC]
IMPORTANT NOTE: IMPORTANT NOTE:
If you experience problems installing, please re-read these If you experience problems installing, please re-read these
@@ -13,7 +15,10 @@ IMPORTANT NOTE:
using (including the beta) and what compiler on what system. One using (including the beta) and what compiler on what system. One
example: wxQt 3.1.0, GCC 4.8.1, Ubuntu 14.04 example: wxQt 3.1.0, GCC 4.8.1, Ubuntu 14.04
* The simplest case Installation {#qt_install}
============
The simplest case {#qt_simple}
------------------- -------------------
If you compile wxWidgets on Linux for the first time and don't like to read If you compile wxWidgets on Linux for the first time and don't like to read
@@ -26,6 +31,7 @@ install instructions just do (in the base dir):
> su <type root password> > su <type root password>
> make install > make install
> ldconfig > ldconfig
[if you get "ldconfig: command not found", try using "/sbin/ldconfig"] [if you get "ldconfig: command not found", try using "/sbin/ldconfig"]
If you don't do the 'make install' part, you can still use the libraries from If you don't do the 'make install' part, you can still use the libraries from
@@ -37,7 +43,7 @@ If you want to remove wxWidgets on Unix you can do this:
> make uninstall > make uninstall
> ldconfig > ldconfig
* The simplest errors The simplest errors {#qt_error_simple}
--------------------- ---------------------
For any configure errors: please look at config.log file which was generated For any configure errors: please look at config.log file which was generated
@@ -52,20 +58,20 @@ qtconfig/pkg-config. Also check that your LD_LIBRARY_PATH or equivalent
variable contains the path to Qt libraries if they were installed in a variable contains the path to Qt libraries if they were installed in a
non-default location. non-default location.
* The simplest program The simplest program {#qt_simple_app}
---------------------- ----------------------
Now create your super-application myfoo.cpp and compile anywhere with Now create your super-application myfoo.cpp and compile anywhere with
g++ myfoo.cpp `wx-config --libs --cxxflags` -o myfoo g++ myfoo.cpp `wx-config --libs --cxxflags` -o myfoo
* GUI libraries GUI libraries {#qt_libs_ui}
--------------- ---------------
wxWidgets/Qt requires the Qt library to be installed on your system. It has wxWidgets/Qt requires the Qt library to be installed on your system. It has
to be a stable version, preferably Qt 5.2.1 or later. to be a stable version, preferably Qt 5.2.1 or later.
* Building wxQT on Ubuntu Building wxQT on Ubuntu {#qt_build_ubuntu}
------------------------- -------------------------
Install latest Qt5 packages (qt5-default). To build unit tests, libcppunit-dev Install latest Qt5 packages (qt5-default). To build unit tests, libcppunit-dev
@@ -91,7 +97,7 @@ cd tests
make make
./test_gui ./test_gui
* Building wxQT, using qt-unified-XXX-online installer Building wxQT, using qt-unified-XXX-online installer {#qt_build}
------------------------------------------------------ ------------------------------------------------------
Download qt-unified-XXX-online installer from the qt website. Download qt-unified-XXX-online installer from the qt website.
@@ -100,14 +106,16 @@ restriction as above).
The same build instructions apply, except that you need to explicitly pass The same build instructions apply, except that you need to explicitly pass
to configure the Qt dir of the build intended to use as QT5_CUSTOM_DIR, i.e. to configure the Qt dir of the build intended to use as QT5_CUSTOM_DIR, i.e.
# for Linux: for Linux:
../configure --with-qt --enable-debug QT5_CUSTOM_DIR=~/Qt/5.11.0/gcc_64 ../configure --with-qt --enable-debug QT5_CUSTOM_DIR=~/Qt/5.11.0/gcc_64
# for Windows (ran from Git Bash, or any other Unix-like shell): for Windows (ran from Git Bash, or any other Unix-like shell):
# (the syntax for the drive in the path is required by ar and ld) (the syntax for the drive in the path is required by ar and ld)
../configure --with-qt --enable-debug QT5_CUSTOM_DIR=c:/Qt/5.11.0/mingw53_32 ../configure --with-qt --enable-debug QT5_CUSTOM_DIR=c:/Qt/5.11.0/mingw53_32
* Building wxGT on Android Building wxGT on Android {#qt_android}
-------------------------- --------------------------
Download Android Native Development Kit (NDK), tandalone Android Software Download Android Native Development Kit (NDK), tandalone Android Software
@@ -146,10 +154,11 @@ make
You can now compile and link your app against this build, and finally You can now compile and link your app against this build, and finally
package it for Android using standard APK tools. package it for Android using standard APK tools.
* Create your configuration Create your configuration {#qt_config}
--------------------------- ---------------------------
Usage: Usage:
./configure options ./configure options
If you want to use system's C and C++ compiler, If you want to use system's C and C++ compiler,
@@ -168,7 +177,7 @@ subdirectory of your wxWidgets installation) as this allows you to
have multiple configurations (for example, debug and release or GTK have multiple configurations (for example, debug and release or GTK
and Motif) simultaneously. and Motif) simultaneously.
* Feature Options Feature Options {#qt_feature_options}
----------------- -----------------
When producing an executable that is linked statically with wxQt When producing an executable that is linked statically with wxQt
@@ -182,10 +191,3 @@ of all configurable options.
Apart from disabling certain features you can very often "strip" Apart from disabling certain features you can very often "strip"
the program of its debugging information resulting in a significant the program of its debugging information resulting in a significant
reduction in size. reduction in size.
----------------------
In the hope that it will be useful,
The wxWidgets Team