Qt Creator Documentation Gallery: Difference between revisions
(Add note about ECMAddQch and KDE Frameworks starting to make use of it) |
m (Fix 'qhc' typo) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 10: | Line 10: | ||
== CMake == | == CMake == | ||
CMake 3.0.0 and upwards can use Sphinx to generate a .qch file | * [https://cmake.org/documentation/ CMake Documentation] | ||
* CMake 3.0.0 and upwards can use Sphinx to generate a .qch file: [http://www.kdab.com/context-sensitive-cmake-documentation-qtcreator/ CMake 3.0.0 Documentation] | |||
== Qwt == | == Qwt == | ||
* "Qwt - Qt Widgets for Technical Applications" : | * "Qwt - Qt Widgets for Technical Applications" : | ||
** [http://sourceforge.net/projects/qwt/files/qwt/6.1.0/qwt-6.1.0.qch/download Qwt-6.1.0 . | ** [http://sourceforge.net/projects/qwt/files/qwt/6.1.0/qwt-6.1.0.qch/download Qwt-6.1.0 .qch file] | ||
** [http://sourceforge.net/projects/qwt/files/qwt/6.0.1/qwt-6.0.1.qch/download Qwt-6.0.1 . | ** [http://sourceforge.net/projects/qwt/files/qwt/6.0.1/qwt-6.0.1.qch/download Qwt-6.0.1 .qch file] | ||
== KDE == | == KDE == | ||
Latest revision as of 21:06, 27 August 2020
This page is meant to list 3rd party documentation files in .qch format that you can view in the Qt Creator Help mode.
C++
- C++ reference documentation from cppreference.com with full C++14 support (with some C++17 elements)
- C++ reference documentation with content from Harvard CS 50 class with C++03 support
CMake
- CMake Documentation
- CMake 3.0.0 and upwards can use Sphinx to generate a .qch file: CMake 3.0.0 Documentation
Qwt
- "Qwt - Qt Widgets for Technical Applications" :
KDE
KDE Online API reference documentation is also available in .qch format!
ECM (extra-cmake-modules) since v5.36.0 has a ECMAddQch module, which provides CMake macros for simple setup of generation of API docs QCH files during the build (using doxygen), including support for cross-linking to other QCH files (like the. Qt ones)
KDE Frameworks since v5.36.0 uses ECMAddQch, with Linux distributions packaging the generated QCH files e.g. as separate package *-devel-doc
LLVM
Here are instructions on how to build a Qt Compressed Help file for the LLVM source: http://llvm-reviews.chandlerc.com/D2967
OpenGL
OGRE
Linux Man Pages
This Qt help file contains Section 2: System calls and Section 3: Library function of the Linux Man Pages. Context-sensitive help by pressing F1 is also available. site
Converters and Generators to/for Qt help files
- There is a (obsolete?) converter for CMake documentation to qch.
Documentation
A book about developing Qt Quick applications by Juergen Bocklage-Ryannel and Johan Thelin.