Qt Creator Documentation Gallery: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
m (Dead link - Complete website is not there anymore.)
(Add note about ECMAddQch and KDE Frameworks starting to make use of it)
Line 21: Line 21:


== KDE ==
== KDE ==
[http://api.kde.org/ KDE Online API reference documentation] is also available in [http://api.kde.org/qch/ .qch format]!


* [http://api.kde.org/ KDE API reference documentation] is available in [http://api.kde.org/qch/ .qch format]!
ECM (extra-cmake-modules) since v5.36.0 has a [https://api.kde.org/ecm/module/ECMAddQch.html 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 ==
== LLVM ==

Revision as of 00:20, 7 June 2017

This page is meant to list 3rd party documentation files in .qch format that you can view in the Qt Creator Help mode.

C++

CMake

CMake 3.0.0 and upwards can use Sphinx to generate a .qch file.

Qwt

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

Documentation

A book about developing Qt Quick applications by Juergen Bocklage-Ryannel and Johan Thelin.