Qt wiki will be updated on October 12th 2023 starting at 11:30 AM (EEST) and the maintenance will last around 2-3 hours. During the maintenance the site will be unavailable.

Qt Creator Documentation Gallery: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
 
m (Fix 'qhc' typo)
 
(12 intermediate revisions by 7 users not shown)
Line 1: Line 1:
=Qt Creator Documentation Gallery=
__NOTOC__
[[Category:Tools::QtCreator]]
This page is meant to list 3rd party documentation files in .qch format that you can view in the [[Qt Creator]] Help mode.


This page is meant to list 3rd party documentation files in .qch format that can get [http://doc.qt.nokia.com/qtcreator-snapshot/creator-help.html integrated into Qt Creator] ''[doc.qt.nokia.com]''.
== C++ ==


==Documentation==
* [http://en.cppreference.com/w/Cppreference:Archives C++ reference documentation] from cppreference.com with full C++14 support (with some C++17 elements)
* [https://docs.google.com/leaf?id=0B6w3G_xx1dDnMjYyMjQ1ODctNGZmMy00MzRhLWJlOGEtMDdhOTc0N2EzOTgx&sort=name&layout=list&num=50 C++ reference documentation] with content from [https://cs50.harvard.edu/resources/cppreference.com/ Harvard CS 50 class] with C++03 support


===C++===
== CMake ==


C++ related documentation.
* [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]


* [https://docs.google.com/leaf?id=0B6w3G_xx1dDnMjYyMjQ1ODctNGZmMy00MzRhLWJlOGEtMDdhOTc0N2EzOTgx&sort=name&layout=list&num=50 C++ reference documentation] ''[docs.google.com]''
== Qwt ==
* [http://en.cppreference.com/w/Cppreference:Archives C++ reference documentation] ''[en.cppreference.com]''


===CMake===
* "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 .qch file]
** [http://sourceforge.net/projects/qwt/files/qwt/6.0.1/qwt-6.0.1.qch/download Qwt-6.0.1 .qch file]


CMake 3.0.0 and upwards can use Sphinx to generate a .qch file.
== KDE ==
[http://api.kde.org/ KDE Online API reference documentation] is also available in [http://api.kde.org/qch/ .qch format]!


* [http://www.kdab.com/context-sensitive-cmake-documentation-qtcreator/ CMake 3.0.0 Documentation] ''[kdab.com]''
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)


Note that Qt Creator 3.2 beta or higher is required for context help (F1) support.
KDE Frameworks since v5.36.0 uses ECMAddQch, with Linux distributions packaging the generated QCH files e.g. as separate package *-devel-doc


===Qwt===
== LLVM ==


* “Qwt – Qt Widgets for Technical Applications” :
Here are instructions on how to build a Qt Compressed Help file for the LLVM source: http://llvm-reviews.chandlerc.com/D2967
** [http://sourceforge.net/projects/qwt/files/qwt/6.1.0/qwt-6.1.0.qch/download Qwt-6.1.0 .qhc file] ''[sourceforge.net]''
** [http://sourceforge.net/projects/qwt/files/qwt/6.0.1/qwt-6.0.1.qch/download Qwt-6.0.1 .qhc file] ''[sourceforge.net]''


===<span class="caps">KDE</span>===
== OpenGL ==


<span class="caps">KDE</span> related documentation.
* [http://code.google.com/p/qtcreator-openglhelp/ OpenGL Help for Qt Creator]


* [http://api.kde.org/ <span class="caps">KDE</span> <span class="caps">API</span> reference documentation] ''[api.kde.org]'' is available in .qch format!
== OGRE ==


===<span class="caps">LLVM</span>===
* [http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help Integrating API documentation into Qt Creator Help]


Here are instructions on how to build a Qt Compressed Help file for the <span class="caps">LLVM</span> source: http://llvm-reviews.chandlerc.com/D2967
== Linux Man Pages ==


===<span class="caps">STL</span>===
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.
[http://shinnok.com/rants/2011/07/19/linux-man-pages-integration-with-qt-creator/ site]


* [http://www.steveire.com/libstdc++-v3.qch <span class="caps">STL</span> documentation] ''[steveire.com]''
== Converters and Generators to/for Qt help files ==


===OpenGL===
* There is a (obsolete?) [http://qt-apps.org/content/show.php/CMake2assistant?content=67492 converter for CMake documentation] to qch.


* [http://code.google.com/p/qtcreator-openglhelp/ OpenGL Help for Qt Creator] ''[code.google.com]''
== Documentation ==


===<span class="caps">OGRE</span>===
A book about [https://qmlbook.github.io/assets/index.html developing Qt Quick applications] by Juergen Bocklage-Ryannel and Johan Thelin.
 
* [http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help Integrating <span class="caps">API</span> documentation into Qt Creator Help] ''[ogre3d.org]''
 
===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.<br />[http://shinnok.com/rants/2011/07/19/linux-man-pages-integration-with-qt-creator/ site] ''[shinnok.com]''
 
==Converters and Generators to/for Qt help files==
 
* There is a (obsolete?) [http://qt-apps.org/content/show.php/CMake2assistant?content=67492 converter for CMake documentation] ''[qt-apps.org]'' to qch.
* [http://www.doxygen.org/ Doxygen] ''[doxygen.org]'' has support for Qt help files. Instructions can be found [https://blog.qt.io/blog/category/doxygen2qthelp/ here] ''[blog.qt.io]''. There is also [http://dev.kofee.org/projects/qtcreator-doxygen/ a plugin for Qt Creator] ''[dev.kofee.org]''
 
===Categories:===
 
* [[:Category:Tools|Tools]]
** [[:Category:Tools::QtCreator|QtCreator]]

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

CMake

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.

Retrieved from "https://wiki-qt-io-staging.herokuapp.com/index.php?title=Qt_Creator_Documentation_Gallery&oldid=37267"