Qt Creator Documentation Gallery: Difference between revisions

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" :
- Qwt-6.1.0 .qch file
- Qwt-6.0.1 .qch file

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

OpenGL Help for Qt Creator

OGRE

Integrating API documentation into Qt Creator Help

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.

@@ Line 1: / Line 1: @@
+__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.
-= Qt Creator Documentation Gallery =
+== C++ ==
-This page is meant to list 3rd party documentation files in .qch format that can get &quot;integrated into Qt Creator&amp;quot;:http://doc.qt.nokia.com/qtcreator-snapshot/creator-help.html.
+* [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
-== Documentation ==
+== CMake ==
-=== C++ ===
-C++ related documentation.
-* &quot;C++ reference documentation&amp;quot;:https://docs.google.com/leaf?id=0B6w3G_xx1dDnMjYyMjQ1ODctNGZmMy00MzRhLWJlOGEtMDdhOTc0N2EzOTgx&amp;amp;sort=name&amp;amp;layout=list&amp;amp;num=50
-* &quot;C++ reference documentation&amp;quot;:http://en.cppreference.com/w/Cppreference:Archives
-=== CMake ===
-CMake 3.0.0 and upwards can use Sphinx to generate a .qch file.
-* &quot;CMake 3.0.0 Documentation&amp;quot;:http://www.kdab.com/context-sensitive-cmake-documentation-qtcreator/
+* [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]
-Note that Qt Creator 3.2 beta or higher is required for context help (F1) support.
+== Qwt ==
-=== Qwt ===
+* "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]
-* &quot;Qwt - Qt Widgets for Technical Applications&amp;quot; :
+== KDE ==
-** &quot;Qwt-6.1.0 .qhc file&amp;quot;:http://sourceforge.net/projects/qwt/files/qwt/6.1.0/qwt-6.1.0.qch/download
+[http://api.kde.org/ KDE Online API reference documentation] is also available in [http://api.kde.org/qch/ .qch format]!
-** &quot;Qwt-6.0.1 .qhc file&amp;quot;:http://sourceforge.net/projects/qwt/files/qwt/6.0.1/qwt-6.0.1.qch/download
-=== KDE ===
+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 related documentation.
+KDE Frameworks since v5.36.0 uses ECMAddQch, with Linux distributions packaging the generated QCH files e.g. as separate package *-devel-doc
-* &quot;KDE API reference documentation&amp;quot;:http://api.kde.org/ is available in .qch format!
+== LLVM ==
-=== LLVM ===
 Here are instructions on how to build a Qt Compressed Help file for the LLVM source: http://llvm-reviews.chandlerc.com/D2967
-=== STL ===
+== OpenGL ==
-* &quot;STL documentation&amp;quot;:http://www.steveire.com/libstdc++-v3.qch
+* [http://code.google.com/p/qtcreator-openglhelp/ OpenGL Help for Qt Creator]
-=== OpenGL ===
+== OGRE ==
-* &quot;OpenGL Help for Qt Creator&amp;quot;:http://code.google.com/p/qtcreator-openglhelp/
+* [http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help Integrating API documentation into Qt Creator Help]
-=== OGRE ===
+== Linux Man Pages ==
-* &quot;Integrating API documentation into Qt Creator Help&amp;quot;:http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help
+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]
-=== Linux Man Pages ===
+== Converters and Generators to/for Qt help files ==
-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 />&quot;site&amp;quot;:http://shinnok.com/rants/2011/07/19/linux-man-pages-integration-with-qt-creator/
+* There is a (obsolete?) [http://qt-apps.org/content/show.php/CMake2assistant?content=67492 converter for CMake documentation] to qch.
-== Converters and Generators to/for Qt help files ==
+== Documentation ==
-* There is a (obsolete?) &quot;converter for CMake documentation&amp;quot;:http://qt-apps.org/content/show.php/CMake2assistant?content=67492 to qch.
+A book about [https://qmlbook.github.io/assets/index.html developing Qt Quick applications] by Juergen Bocklage-Ryannel and Johan Thelin.